cisco.aci.aci_interface_policy_mcp – Управление политиками интерфейсов MCP (mcp:IfPol)

Примечание

Этот плагин является частью коллекции cisco.aci (версия 1.1.1).

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

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

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

Обзор

Управление политиками интерфейсов MCP на Cisco ACI сетях.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state boolean	Варианты: no yes	Включение или отключение состояния администрирования. APIC по умолчанию устанавливает `yes`, если значение не указано при создании.
annotation string		Пользовательская строка для аннотации объекта. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_ANNOTATION`
certificate_name string		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, значение по умолчанию устанавливается как имя файла `private_key`, без расширения. Если для `private_key` предоставлено содержимое в формате PEM, значение по умолчанию устанавливается как значение `username` Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME` алиасы: cert_name
description string		Описание интерфейса MCP. алиасы: descr
host string / required		IP-адрес или имя хоста APIC, разрешимое хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST` алиасы: hostname
mcp string		Имя интерфейса MCP. алиасы: mcp_interface, name
name_alias string		Псевдоним для текущего объекта. Относится к полю nameAlias в ACI.
output_level string	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`
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 string		Файл приватного ключа в формате PEM или содержимое приватного ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если также предоставлено значение `password`, оно будет проигнорировано. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PRIVATE_KEY` алиасы: cert_key
state string	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода списка объекта или нескольких объектов.
timeout integer	По умолчанию: 30	Таймаут на уровне сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`
use_proxy boolean	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`
use_ssl boolean	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS соединения будет использоваться HTTP соединение. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`
username string	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы переменные окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME` алиасы: user
validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в `no` при использовании на контролируемых сайтах с самозаверяющимися сертификатами. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`

См. также

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

Примеры

- name: Add a MCP interface policy
  cisco.aci.aci_interface_policy_mcp:
    host: '{{ hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    mcp: '{{ mcp }}'
    description: '{{ descr }}'
    admin_state: '{{ admin_state }}'
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
current список / элементы=строка	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	неудача	Информация об ошибке, возвращённая APIC Пример: {'code': '122', 'text': 'неизвестный тип управляемого объекта foo'}
filter_string строка	неудача или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	неудача или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список / элементы=строка	информация	Исходная конфигурация с APIC до начала модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров пользователя Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'производство'}}}
raw строка	ошибка разбора	Необработанный результат, возвращённый REST API APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный тип управляемого объекта foo"/></imdata>
response строка	неудача или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список / элементы=строка	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	неудача или отладка	HTTP-статус от APIC Пример: 200
url строка	неудача или отладка	HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Dag Wieers (@dagwieers)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_interface_policy_mcp_module.html