Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_node_block.

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

Обзор

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

Параметры

Параметр

Комментарии

access_port_selector

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

строка

Имя селектора порта коммутатора листа/спины Fabric access policy.

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-адрес или имя хоста, разрешаемое хостом управления 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

строка

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

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

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

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

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

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

Варианты:

  • false
  • true
END_OF_DOCUMENT_MARKER

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

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

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

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

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

Выбираемые значения:

  • false
  • true

switch_profile

aliases: leaf_profile_name, leaf_profile, switch_profile_name, spine_switch_profile, spine_switch_profile_name

string

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

timeout

integer

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

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

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

to_port

aliases: to, to_port_range

string

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

type_node

aliases: type

string

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

Выбираемые значения:

  • "leaf"
  • "spine"

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

Примечания

Примечание

  • При добавлении блока портов к селектору портов коммутатора доступа типа 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 доступа Fabric (infra:SpineP).

cisco.aci.aci_access_spine_switch_selector

Управление селекторами портов коммутатора Spine доступа Fabric (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

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

Существующая конфигурация из 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"

Авторы

  • Gaspard Micol (@gmicol)

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

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

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

Spec-Zone.ru

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