Модуль cisco.aci.aci_system_connectivity_preference — настройки подключения APIC (mgmt:ConnectivityPrefs)

Примечание

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

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

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

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

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

Краткое описание

Управляет настройками подключения APIC в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name string	Имя сертификата X.509, привязанного к пользователю APIC AAA, который используется для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется имя `private_key` без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_CERTIFICATE_NAME`.
host псевдонимы: hostname string	IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_HOST`.
interface_preference псевдонимы: interface_pref, int_pref, external_connection string	Интерфейс для внешнего подключения. Варианты: `"inband"` `"ooband"`
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`. Для вывода списка объектов используйте `query`. Варианты: `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, перед обновлением POST в APIC не будет отправляться GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в этом случае возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверяться, а запрос POST на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после обновления POST в APIC не будет отправляться проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в этом случае возвращаемое значение current будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `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 псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL проверяться не будут. Устанавливайте значение `false` только на сайтах под вашим контролем, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

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

Примеры

- name: Configure Out-of-band Connectivity Preference
  cisco.aci.aci_system_connectivity_preference:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_preference: ooband
    state: present
  delegate_to: localhost

- name: Configure In-band Connectivity Preference
  cisco.aci.aci_system_connectivity_preference:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_preference: inband
    state: present
  delegate_to: localhost

- name: Query Management Connectivity Preference
  cisco.aci.aci_system_connectivity_preference:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
current list / elements=string	Существующая конфигурация APIC после завершения работы модуля Возвращается: success Пример: `[{"mgmtConnectivityPrefs": {"attributes": {"annotation": "", "childAction": "", "descr": "", "dn": "uni/fabric/connectivityPrefs", "extMngdBy": "", "interfacePref": "inband", "lcOwn": "local", "modTs": "2023-11-14T16:25:32.629+00:00", "name": "default", "nameAlias": "", "ownerKey": "", "ownerTag": "", "status": "", "uid": "0"}}}]`
error dictionary	Сведения об ошибке, возвращенные APIC Возвращается: failure Пример: `{"code": "120", "text": "unknown property value foo, name interfacePref, class mgmtConnectivityPrefs [(Dn0)] Dn0=, "}`
filter_string string	Строка фильтра, использованная для запроса Возвращается: failure или debug Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: failure или debug Пример: `"POST"`
previous list / elements=string	Исходная конфигурация APIC до запуска модуля Возвращается: info Пример: `[{"mgmtConnectivityPrefs": {"attributes": {"annotation": "", "descr": "", "dn": "uni/fabric/connectivityPrefs", "interfacePref": "ooband", "name": "default", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Сформированная конфигурация на основе параметров, заданных пользователем Возвращается: info Пример: `{"mgmtConnectivityPrefs": {"attributes": {"interfacePref": "inband"}}}`
raw string	Необработанный вывод REST API APIC (XML или JSON) Возвращается: parse error Пример: `"{'imdata': [{'error': {'attributes': {'code': '120', 'text': 'unknown property value foo, name interfacePref, class mgmtConnectivityPrefs [(Dn0)] Dn0=, '}}}], 'totalCount': '1'}"`
response string	Ответ HTTP от APIC Возвращается: failure или debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"mgmtConnectivityPrefs": {"attributes": {"interfacePref": "inband"}}}`
status integer	Статус HTTP от APIC Возвращается: failure или debug Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: failure или debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

David Neilan (@dneilan-intel)

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

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