Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_node_block — управление блоком узлов (infra:NodeBlk)

Примечание

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

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

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

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

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

Краткое описание

  • Управление блоками узлов в фабриках Cisco ACI.
  • Блок узлов — это диапазон узлов. Каждый блок узлов начинается с первого порта и заканчивается последним портом.

Параметры

Параметр

Комментарии

access_port_selector

псевдонимы: access_port_selector_name, port_selector, port_selector_name

строка

Имя селектора портов коммутатора leaf/spine в политике доступа фабрики.

annotation

строка

Пользовательская строка для добавления аннотации к объекту.

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

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

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

certificate_name

псевдонимы: cert_name

строка

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

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

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

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

description

псевдонимы: node_block_description

строка

Описание блока узлов.

from_port

псевдонимы: from, from_port_range

строка

Начало диапазона портов блока узлов.

host

псевдонимы: hostname

строка

IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible.

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

node_block

псевдонимы: node_block_name, name

строка

Имя блока узлов.

output_level

строка

Определяет состав выходных данных этого модуля ACI.

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

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

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

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

Варианты:

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

output_path

строка

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

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

password

строка

Пароль для аутентификации.

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

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

port

целое число

Номер порта для REST-подключения.

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

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

private_key

псевдонимы: cert_key

строка

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

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

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

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

state

строка

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

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

Варианты:

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

suppress_previous

псевдонимы: no_previous, ignore_previous

логический

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

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

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

ПРЕДУПРЕЖДЕНИЕ — в этом случае возвращаемое значение предыдущего состояния будет пустым.

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

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

логический

Если true, после отправки POST-запроса на обновление в APIC проверочный GET-запрос отправляться не будет.

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

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

ПРЕДУПРЕЖДЕНИЕ — в этом случае возвращаемое значение текущего состояния будет установлено равным предлагаемому значению.

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

Варианты:

  • false
  • true

switch_profile

псевдонимы: leaf_profile_name, leaf_profile, switch_profile_name, spine_switch_profile, spine_switch_profile_name

строка

Имя профиля коммутатора leaf/spine в политике доступа фабрики.

timeout

целое число

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

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

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

to_port

псевдонимы: to, to_port_range

строка

Конец диапазона портов блока узлов.

type_node

псевдонимы: type

строка

Тип создаваемого блока узлов для соответствующего порта доступа.

Варианты:

  • "leaf"
  • "spine"

use_proxy

логический

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

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

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

Варианты:

  • false
  • true

use_ssl

логический

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

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

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

Варианты:

  • false
  • true

username

псевдонимы: user

строка

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

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

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

validate_certs

логический

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

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

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

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

Варианты:

  • false
  • true

Примечания

Примечание

  • При добавлении блока портов к селектору портов коммутатора leaf доступа с типом leaf перед использованием этого модуля в плейбуке необходимо создать switch_profile и access_port_selector. Для этого можно использовать модули cisco.aci.aci_switch_policy_leaf_profile и cisco.aci.aci_switch_leaf_selector.
  • При добавлении блока портов к селектору портов коммутатора доступа типа type spine перед использованием этого модуля в плейбуке необходимо создать switch_profile и access_port_selector. Для этого можно использовать модули cisco.aci.aci_access_spine_switch_profile и cisco.aci.aci_access_spine_switch_selector.

См. также

См. также

cisco.aci.aci_switch_policy_leaf_profile

Управление профилями политик коммутаторов leaf (infra:NodeP).

cisco.aci.aci_switch_leaf_selector

Привязка селекторов leaf к профилям политик коммутаторов leaf (infra:LeafS, infra:NodeBlk и infra:RsAccNodePGrp).

cisco.aci.aci_access_spine_switch_profile

Управление профилями коммутаторов spine для доступа к фабрике (infra:SpineP).

cisco.aci.aci_access_spine_switch_selector

Управление селекторами портов коммутаторов spine в политике доступа фабрики (infra:SpineS).

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

Дополнительная информация о внутренних классах APIC infra:NodeBlk.

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

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

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

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

Примеры

- name: Add a new Node Block associated to a switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    node_block: my_node_block
    from_port: 1011
    to_port: 1011
    type_node: leaf
    state: present
  delegate_to: localhost

- name: Add a new Node Block associated to a switch policy spine profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_spine_switch_profile
    access_port_selector: my_spine_switch_selector
    node_block: my_node_block
    from_port: 1012
    to_port: 1012
    type_node: spine
    state: present
  delegate_to: localhost

- name: Query a Node Block associated to a switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    node_block: my_node_block
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Node Blocks under the switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Node Blocks
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove a Node Block associated to a switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    node_block: my_node_block
    type_node: leaf
    state: absent
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

current

list / elements=string

Текущая конфигурация из APIC после выполнения модуля

Возвращается: success

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

error

dictionary

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

Возвращается: failure

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

filter_string

string

Строка фильтра, использованная в запросе

Возвращается: failure or debug

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

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

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

Возвращается: info

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

proposed

dictionary

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

Возвращается: info

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

raw

string

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

Возвращается: parse error

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

response

string

Ответ HTTP от APIC

Возвращается: failure or debug

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

sent

list / elements=string

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

Возвращается: info

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

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure or debug

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

Авторы

  • Gaspard Micol (@gmicol)

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

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

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

Spec-Zone.ru

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