Модуль cisco.aci.aci_interface_blacklist – Включение или отключение физических интерфейсов (fabric:RsOosPath)

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_interface_blacklist.

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

Обзор

Включает или отключает физические интерфейсы на Cisco ACI фабриках.

Параметры

Параметр	Комментарии
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`.
fex_id целое число	ID fex, к которому принадлежит `interface`. Значение `fex_id` обычно имеет вид ‘123’.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`.
interface строка	Имя `interface`, на который нацелена задача. Обычно имя интерфейса в формате `1/7`.
node_id псевдонимы: leaf, spine, node целое число	ID коммутатора, к которому принадлежит `interface`. Значение `node_id` обычно имеет вид ‘101’.
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`.
pod_id псевдонимы: pod, pod_number целое число	Номер подсети. `pod_id` обычно целое число меньше `12`.
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`

suppress_verification aliases: 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 aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверяться. Это следует устанавливать в `false` только при работе с собственными самозаверенными сертификатами на контролируемых сайтах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

Справочник по модели управления информацией APIC: Дополнительная информация о внутреннем классе APIC fabric:RsOosPath.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия.

Примеры

- name: Disable Interface
  cisco.aci.aci_interface_blacklist:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    interface: 1/49
    state: present
  delegate_to: localhost

- name: Enable Interface
  cisco.aci.aci_interface_blacklist:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    interface: 1/49
    state: absent
  delegate_to: localhost

- name: Disable Interface on Fex
  cisco.aci.aci_interface_blacklist:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    fex_id: 123
    interface: 1/49
    state: present
  delegate_to: localhost

- name: Enable Interface on Fex
  cisco.aci.aci_interface_blacklist:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    fex_id: 123
    interface: 1/49
    state: absent
  delegate_to: localhost

- name: Query Interface
  cisco.aci.aci_interface_blacklist:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    interface: 1/49
    state: query
  delegate_to: localhost

- name: Query All Interfaces
  cisco.aci.aci_interface_blacklist:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    state: query
  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"`

Авторы

Akini Ross (@akinross)

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

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