cisco.asa.asa_facts – Сбор фактов с удалённых устройств Cisco ASA
Примечание
Этот плагин является частью коллекции cisco.asa (версия 1.0.4).
Для его установки используйте: ansible-galaxy collection install cisco.asa.
Для использования в playbook, укажите: cisco.asa.asa_facts.
Новое в версии 1.0.0: модуля cisco.asa
Обзор
- Сбор базового набора фактов устройства с удалённого устройства ASA. Этот модуль добавляет к ключам всех базовых сетевых фактов
ansible_net_<fact>. Модуль facts всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов. - Обратите внимание, чтобы правильно собрать факты с устройства ASA, пользователь должен получить права администратора.
Примечание
Этот модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authorize boolean |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.Для получения дополнительной информации см. Руководство по сети. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| context строка | Указывает контекст, на который необходимо нацелиться, если вы работаете с ASA в режиме множественных контекстов. По умолчанию используется текущий контекст, в который вы вошли. | ||
| gather_network_resources список / элементы=строка | При указании этот аргумент ограничит собираемые факты заданным подмножеством. Возможные значения этого аргумента включают all и ресурсы, такие как интерфейсы, VLANы и т.д. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания того, что определённое подмножество не должно собираться. Действительные подмножества — 'all', 'acls', 'ogs'. | ||
| gather_subset список / элементы=строка | По умолчанию: "!config" | При указании этот аргумент ограничивает собираемые факты заданным подмножеством. Возможные значения этого аргумента включают all, min, hardware, config.Укажите список значений для включения большего подмножества. Используйте значение с начальным ! для сбора всех фактов, кроме этого подмножества. | |
| passwords boolean |
| Указывает контекст, на который необходимо нацелиться, если вы работаете с ASA в режиме множественных контекстов. По умолчанию используется текущий контекст, в который вы вошли. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий данные соединения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт, который нужно использовать при построении соединения с удалённым устройством. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для соединения. Полезно, если консоль зависает перед продолжением, например, при сохранении конфигураций. | ||
| username строка | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Проверено на asa 9.10(1)11
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
Примеры
- name: Gather all legacy facts
cisco.asa.asa_facts:
gather_subset: all
- name: Gather only the config and default facts
cisco.asa.asa_facts:
gather_subset:
- config
- name: Do not gather hardware facts
cisco.asa.asa_facts:
gather_subset:
- '!hardware'
- name: Gather legacy and resource facts
cisco.asa.asa_facts:
gather_subset: all
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_api string | всегда | Имя протокола передачи |
| ansible_net_asatype string | всегда | Тип операционной системы (Cisco ASA) на удалённом устройстве. |
| ansible_net_config string | при конфигурации config | Текущая активная конфигурация устройства |
| ansible_net_device_mgr_version string | всегда | Версия менеджера устройств, работающего на удалённом устройстве. |
| ansible_net_filesystems list / elements=string | при конфигурации аппаратного обеспечения | Все имена файловых систем, доступные на устройстве |
| ansible_net_filesystems_info dictionary | при конфигурации аппаратного обеспечения | Словарь всех файловых систем, содержащий информацию о каждой файловой системе (например, свободное и общее пространство) |
| ansible_net_firepower_version string | всегда | Версия операционной системы Firepower, работающей на удалённом устройстве. |
| ansible_net_gather_subset list / elements=string | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_hostname string | всегда | Настроенное имя хоста устройства |
| ansible_net_image string | всегда | Файл образа, используемый устройством |
| ansible_net_memfree_mb integer | при конфигурации аппаратного обеспечения | Доступная свободная память на удалённом устройстве в Мб |
| ansible_net_memtotal_mb integer | при конфигурации аппаратного обеспечения | Общая память на удалённом устройстве в Мб |
| ansible_net_memused_mb integer | при конфигурации аппаратного обеспечения | Используемая память на удалённом устройстве в Мб |
| ansible_net_model string | всегда | Модель, возвращённая устройством |
| ansible_net_python_version string | всегда | Версия Python, используемая контроллером Ansible |
| ansible_net_serialnum string | всегда | Серийный номер удалённого устройства |
| ansible_net_stacked_models list / elements=string | при конфигурации нескольких устройств в стеке | Названия моделей каждого устройства в стеке |
| ansible_net_stacked_serialnums list / elements=string | при конфигурации нескольких устройств в стеке | Серийные номера каждого устройства в стеке |
| ansible_net_version string | всегда | Версия операционной системы, работающей на удалённом устройстве |
Авторы
- Sumit Jaiswal (@justjais)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/asa/asa_facts_module.html
