Spec-Zone.ru › Ansible 2.10

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>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
  • Обратите внимание, что для правильного сбора фактов с устройства ASA пользователю необходимо повысить привилегии.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
authorize
boolean
    Варианты:
  • нет ←
  • да
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.
Для получения дополнительной информации см. Руководство по сети.
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
context
строка
Указывает, какой контекст использовать, если устройство ASA работает в режиме нескольких контекстов. По умолчанию используется текущий контекст входа.
gather_network_resources
список / элементы=строка
При указании данного аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, VLANы и т.д. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания того, что конкретное подмножество не должно собираться. Действительные подмножества – это 'все', 'acls', 'ogs'.
gather_subset
список / элементы=строка
По умолчанию:
"!config"
При указании данного аргумента сбор фактов будет ограничен заданным подмножеством.
Возможные значения для этого аргумента включают all, min, hardware, config.
Укажите список значений для включения большего подмножества.
Используйте значение с начальным ! для сбора всех фактов, кроме этого подмножества.
passwords
boolean
    Варианты:
  • нет
  • да
Указывает, какой контекст использовать, если устройство ASA работает в режиме нескольких контекстов. По умолчанию используется текущий контекст входа.
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Для получения дополнительной информации см. Руководство по сети.
Объект словаря, содержащий сведения о подключении.
auth_pass
строка
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения 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
строка
всегда
Имя протокола передачи данных

ansible_net_asatype
строка
всегда
Тип операционной системы (Cisco ASA) на удалённом устройстве.

ansible_net_config
строка
при конфигурации config
Текущая активная конфигурация устройства

ansible_net_device_mgr_version
строка
всегда
Версия менеджера устройств, работающего на удалённом устройстве.

ansible_net_filesystems
список / элементы=строка
при конфигурации оборудования
Все имена файловых систем, доступные на устройстве

ansible_net_filesystems_info
словарь
при конфигурации оборудования
Хэш всех файловых систем, содержащий информацию о каждой файловой системе (например, свободный и общий объём).

ansible_net_firepower_version
строка
всегда
Версия операционной системы Firepower, работающей на удалённом устройстве.

ansible_net_gather_subset
список / элементы=строка
всегда
Список подмножеств фактов, собранных с устройства

ansible_net_hostname
строка
всегда
Настроенное имя хоста устройства

ansible_net_image
строка
всегда
Файл образа, используемый устройством

ansible_net_memfree_mb
целое число
при конфигурации оборудования
Доступная свободная память на удалённом устройстве в Мб

ansible_net_memtotal_mb
целое число
при конфигурации оборудования
Общий объём памяти на удалённом устройстве в Мб

ansible_net_memused_mb
целое число
при конфигурации оборудования
Используемая память на удалённом устройстве в Мб

ansible_net_model
строка
всегда
Название модели, возвращаемое устройством

ansible_net_python_version
строка
всегда
Версия Python, используемая контроллером Ansible

ansible_net_serialnum
строка
всегда
Серийный номер удалённого устройства

ansible_net_stacked_models
список / элементы=строка
при конфигурации нескольких устройств в стеке
Названия моделей каждого устройства в стеке

ansible_net_stacked_serialnums
список / элементы=строка
при конфигурации нескольких устройств в стеке
Серийные номера каждого устройства в стеке

ansible_net_version
строка
всегда
Версия операционной системы, работающей на удалённом устройстве



Авторы

  • Sumit Jaiswal (@justjais)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/asa/asa_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API