cisco.aci.aci_system модуль – Запрос информации о системе ACI (вверху: Система)

Примечание

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

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

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

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

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

Обзор

Запрос информации о системе ACI на Cisco ACI.

Параметры

Параметр	Комментарии
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если было предоставлено имя файла `private_key`, по умолчанию используется имя без расширения, полученное из `private_key`. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемое управляющим хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST`.
id псевдонимы: controller, node целое число	ID узла контроллера.
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`.
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 строка	Используйте `query` для отображения объекта или нескольких объектов. Варианты: `"query"` ← (по умолчанию)
suppress_previous псевдонимы: no_previous, ignore_previous логическое	Если `true`, GET-запрос для проверки предыдущего состояния не будет отправлен перед POST-обновлением в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверяться, и POST-обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое	Если `true`, проверяющий GET-запрос не будет отправлен после POST-обновления в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Варианты: `false` `true`
timeout целое число	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию - 30.
use_proxy логическое	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию - true. Варианты: `false` `true`

END_OF_DOCUMENT_MARKER

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 top:System.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Query all controllers system information
  cisco.aci.aci_system:
    host: apic
    username: userName
    password: somePassword
    validate_certs: false
    state: query
  delegate_to: localhost

- name: Query controller 1 specific system information
  cisco.aci.aci_system:
    host: apic
    username: userName
    password: somePassword
    validate_certs: false
    id: 1
    state: query
  delegate_to: localhost

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

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

Ключ	Описание
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 APIC REST (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"`

Авторы

Lionel Hercot (@lhercot)

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

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