cisco.aci.aci_interface_policy_cdp модуль — Управление политиками интерфейсов CDP (cdp:IfPol)

Примечание

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

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

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

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

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

Обзор

Управление политиками интерфейсов CDP на ЦИСК ACI тканях.

Параметры

Параметр	Комментарии
admin_state boolean	Включить или отключить состояние CDP. По умолчанию в APIC используется `true` при отсутствии значения во время создания. Варианты: `false` `true`
annotation string	Определяемая пользователем строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. Значение по умолчанию: `"orchestrator:ansible"`
cdp_policy псевдонимы: cdp_interface, name string	Имя политики интерфейса CDP.
certificate_name псевдонимы: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл `private_key`, по умолчанию используется базовое имя `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr string	Описание имени политики интерфейса CDP.
host псевдонимы: hostname string	IP-адрес или имя хоста APIC, разрешаемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
name_alias string	Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.
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`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`

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

См. также

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

Примеры

- name: Create CDP Interface Policy to enable CDP
  cisco.aci.aci_interface_policy_cdp:
    name: Ansible_CDP_Interface_Policy
    host: apic.example.com
    username: admin
    password: adminpass
    admin_state: true
    state: present

- name: Create CDP Interface Policy to disable CDP
  cisco.aci.aci_interface_policy_cdp:
    name: Ansible_CDP_Interface_Policy
    host: apic.example.com
    username: admin
    password: adminpass
    admin_state: false
    state: present

- name: Remove CDP Interface Policy
  cisco.aci.aci_interface_policy_cdp:
    name: Ansible_CDP_Interface_Policy
    host: apic.example.com
    username: admin
    password: adminpass
    output_level: debug
    state: absent

- name: Query CDP Policy
  cisco.aci.aci_interface_policy_cdp:
    host: apic.example.com
    username: admin
    password: adminpass
    state: query

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

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

Ключ	Описание
current список / элементы=строка	Текущая конфигурация с APIC после завершения модуля Возвращается при: успехе Пример: `[{"cdpIfPol": {"attributes": {"adminSt": "disabled", "annotation": "", "descr": "Ansible Created CDP Test Policy", "dn": "uni/infra/cdpIfP-Ansible_CDP_Test_Policy", "name": "Ansible_CDP_Test_Policy", "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 строка	Необработанный вывод, возвращённый APIC REST API (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"`

Авторы

Tim Knipper (@tknipper11)

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

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