Spec-Zone.ru › Ansible

модуль cisco.aci.aci_fabric_wide_settings — Управление общими настройками фабрики (infra:SetPol)

Примечание

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

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

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

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

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

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

  • Управление общими настройками фабрик Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

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

certificate_name

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

string

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

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

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

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

disable_remote_ep_learning

boolean

Отключать ли обучение удалённым конечным точкам в VRF, содержащих внешние мостовые/маршрутизируемые домены.

Если при создании параметр не задан, APIC использует значение false по умолчанию.

Допустимые значения:

  • false
  • true

enforce_domain_validation

boolean

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

Запрос проверки домена выполняется один раз. После включения её нельзя отключить.

Если при создании параметр не задан, APIC использует значение false по умолчанию.

Допустимые значения:

  • false
  • true

enforce_epg_vlan_validation

boolean

Выполнять ли проверку, предотвращающую связывание перекрывающихся пулов VLAN с EPG.

Если при создании параметр не задан, APIC использует значение false по умолчанию.

Допустимые значения:

  • false
  • true

enforce_subnet_check

boolean

Отключать ли обучение IP-адресам за пределами подсетей, настроенных в VRF, для всех VRF.

Если при создании параметр не задан, APIC использует значение false по умолчанию.

Допустимые значения:

  • false
  • true

host

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

string

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

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

leaf_opflex_client_auth

boolean

Требовать ли аутентификацию клиентского сертификата Opflex на коммутаторах leaf для GOLF и Linux.

Если при создании параметр не задан, APIC использует значение true по умолчанию.

Допустимые значения:

  • false
  • true

leaf_ssl_opflex

boolean

Включать ли транспорт SSL Opflex для коммутаторов leaf.

Если при создании параметр не задан, APIC использует значение true по умолчанию.

Допустимые значения:

  • false
  • true

opflex_ssl_versions

list / элементы=string

Версии TLS, которые следует включить для Opflex.

При настройке любой из версий TLS необходимо явно указать состояние для каждой из них.

Допустимые значения:

  • "tls_v1.0"
  • "tls_v1.1"
  • "tls_v1.2"

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.

owner_key

string

Строка, заданная пользователем для атрибута ownerKey объекта ACI.

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

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

owner_tag

string

Строка, заданная пользователем для атрибута ownerTag объекта ACI.

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

Например, для указания создателя этого объекта.

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

password

string

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

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

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

port

integer

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

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

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

private_key

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

string

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

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

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

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

reallocate_gipo

boolean

Перераспределять ли некоторые GIPO нерастянутых BD, чтобы освободить место для растянутых BD.

Запрос перераспределения GIPO выполняется один раз. После включения его нельзя отключить.

Если при создании параметр не задан, APIC использует значение false по умолчанию.

Допустимые значения:

  • false
  • true

restrict_infra_vlan_traffic

boolean

Ограничивать ли трафик инфраструктурной VLAN только указанными сетевыми путями. Эти разрешённые сетевые пути задаются политиками входа безопасности инфраструктуры.

Если при создании параметр не задан, APIC использует значение false по умолчанию.

Допустимые значения:

  • false
  • true

spine_opflex_client_auth

boolean

Требовать ли аутентификацию клиентского сертификата Opflex на коммутаторах spine для GOLF и Linux.

Если при создании параметр не задан, APIC использует значение true по умолчанию.

Допустимые значения:

  • false
  • true

spine_ssl_opflex

boolean

Включать ли транспорт SSL Opflex для коммутаторов spine.

Если при создании параметр не задан, APIC использует значение true по умолчанию.

Допустимые значения:

  • false
  • true

state

string

Используйте present для обновления конфигурации.

Используйте query для отображения текущей конфигурации.

Допустимые значения:

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

suppress_previous

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

boolean

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

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

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

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

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

Допустимые значения:

  • false
  • true

suppress_verification

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

boolean

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

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

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

string

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

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

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

validate_certs

boolean

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

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

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

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

Допустимые значения:

  • false
  • true

См. также

См. также

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

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

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

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

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

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

Примеры

- name: Update Fabric Wide Settings
  cisco.aci.aci_fabric_wide_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    disable_remote_ep_learning: true
    enforce_epg_vlan_validation: true
    state: present
  delegate_to: localhost

- name: Update Opflex SSL versions
  cisco.aci.aci_fabric_wide_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    opflex_ssl_versions: [tls_v1.2]
    state: present
  delegate_to: localhost

- name: Query Fabric Wide Settings
  cisco.aci.aci_fabric_wide_settings:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

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"

Авторы

  • Tim Cragg (@timcragg)
  • Akini Ross (@akinross)

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

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

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

Spec-Zone.ru

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