Модуль cisco.aci.aci_dhcp_option — Управление параметрами DHCP (dhcp:Option)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_dhcp_option.

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

Описание

Управление параметрами DHCP для политик DHCP Options на устройствах Cisco ACI.
Параметр DHCP используется для предоставления клиентам DHCP параметров конфигурации, таких как домен, сервер имен, подсеть и сетевой адрес. DHCP предоставляет основу для передачи информации о конфигурации клиентам в сети TCP/IP. Параметры конфигурации и другая управляющая информация передаются в помеченных данных, которые хранятся в поле параметров сообщения DHCP. Эти данные также называются параметрами. Вы можете просматривать, устанавливать, сбрасывать и редактировать значения параметров DHCP. При установке значения параметра DHCP-сервер заменяет любое существующее значение или создаёт новое, по мере необходимости, для данного имени параметра.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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`.
data строка	Значение DHCP опции.
dhcp_option псевдонимы: dhcp_option_name, name строка	Имя DHCP опции.
dhcp_option_policy псевдонимы: dhcp_option_policy_name строка	Имя существующей DHCP политики опции.
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешимые хостом Ansible. Если значение не указано в задании, будет использовано значение переменной среды `ACI_HOST`.
id целое число	Идентификатор DHCP опции.
output_level строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts. `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 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`
tenant aliases: tenant_name string	Имя существующего тенанта.
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`

Примечания

Примечание

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

См. также

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

Примеры

- name: Add a new DHCP Option
  cisco.aci.aci_dhcp_option:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    dhcp_option_policy: my_dhcp_option_policy
    dhcp_option: my_dhcp_option
    id: 1
    data: 82
    state: present
  delegate_to: localhost

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

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

- name: Query all DHCP Options in my_dhcp_option_policy
  cisco.aci.aci_dhcp_option:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    dhcp_option_policy: my_dhcp_option_policy
    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 строка	Необработанный вывод, возвращенный 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"`

Авторы

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_module.html