Модуль cisco.aci.aci_dhcp_option_policy – Управление политикой DHCP-опций (dhcp:OptionPol)

Примечание

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

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

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

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

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

Обзор

Управление политикой DHCP-опций для арендаторов на 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`.
description псевдонимы: descr строка	Описание DHCP Option Policy.
dhcp_option_policy псевдонимы: dhcp_option_policy_name, name строка	Имя DHCP Option Policy.
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешаемого хостом Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`.
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`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_TAG`.
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`

suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после обновления POST на APIC не будет отправлен запрос GET для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приведет к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Варианты: `false` `true`
tenant aliases: tenant_name string	Название существующего арендатора.
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`

Примечания

Примечание

Перед использованием данного модуля в вашем плейбуке должен существовать tenant. Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
APIC Management Information Model reference: Дополнительная информация о внутренних классах APIC
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия в проекте.

Примеры

- name: Add a new DHCP Option Policy
  cisco.aci.aci_dhcp_option_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    dhcp_option_policy: my_dhcp_option_policy
    state: present
  delegate_to: localhost

- name: Delete an DHCP Option Policy
  cisco.aci.aci_dhcp_option_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    dhcp_option_policy: my_dhcp_option_policy
    state: absent
  delegate_to: localhost

- name: Query a DHCP Option Policy
  cisco.aci.aci_dhcp_option_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    dhcp_option_policy: my_dhcp_option_policy
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all DHCP Option Policies in my_tenant
  cisco.aci.aci_dhcp_option_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
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 строка	Необработанный вывод, возвращённый REST API 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_dhcp_option_policy_module.html