Spec-Zone.ru › Ansible 2.6

cnos_facts - Сбор фактов с удалённых устройств, работающих под управлением Lenovo CNOS

Новое в версии 2.3.

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

  • Сбор базового набора фактов устройства с удалённого устройства Lenovo, работающего под управлением CNOS. Этот модуль добавляет к ключам всех базовых сетевых фактов префикс ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_pass
(добавлен в 2.6)
Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
bool

(добавлен в 2.6)
    Варианты:
  • no ←
  • yes
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
gather_subset
(добавлен в 2.6)
По умолчанию:
"!config"
Если указано, этот аргумент ограничит собранные факты заданным подмножеством. Возможные значения для этого аргумента включают all, hardware, config и interfaces. Можно указать список значений для включения более широкого подмножества. Значения также могут использоваться с начальным ! для указания того, что определённое подмножество не должно собираться.
provider
(добавлен в 2.6)
Объект типа dict, содержащий данные подключения.
host
обязательно
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве целевого адреса для протокола.
port По умолчанию:
22
Указывает порт, который необходимо использовать при построении подключения к удалённому устройству.
username
Настраивает имя пользователя для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
password
Указывает пароль, который необходимо использовать для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
timeout По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
ssh_keyfile
Указывает SSH-ключ, который необходимо использовать для проверки подлинности подключения к удалённому устройству. Это значение представляет собой путь к ключу, используемому для проверки подлинности сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.

Примечания

Примечание

  • Проверено на CNOS 10.8.0.42

Примеры

Tasks: The following are examples of using the module cnos_facts.
---
- name: Test cnos Facts
  cnos_facts:
    provider={{ cli }}

  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: 22
      username: admin
      password: admin
      transport: cli
      timeout: 30
      authorize: True
      auth_pass:

---
# Collect all facts from the device
- cnos_facts:
    gather_subset: all
    provider: "{{ cli }}"

# Collect only the config and default facts
- cnos_facts:
    gather_subset:
      - config
    provider: "{{ cli }}"

# Do not collect hardware facts
- cnos_facts:
    gather_subset:
      - "!hardware"
    provider: "{{ cli }}"

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

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

Ключ Возвращаемое значение Описание
ansible_net_all_ipv4_addresses
список
при конфигурировании interfaces
Все IPv4-адреса, настроенные на устройстве

ansible_net_all_ipv6_addresses
список
при конфигурировании interfaces
Все IPv6-адреса, настроенные на устройстве

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

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

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

ansible_net_image
строка
всегда
Указывает активную версию образа для устройства

ansible_net_interfaces
словарь
при конфигурировании interfaces
Хеш-таблица всех интерфейсов, работающих в системе. Предоставляет информацию о описании, MAC-адресе, MTU, скорости, дуплексе и статусе работы.

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

ansible_net_model
строка
всегда
Имя модели, возвращённое устройством Lenovo CNOS

ansible_net_neighbors
словарь
при конфигурировании interfaces
Список соседей LLDP с удалённого устройства

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

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



Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как общедоступный, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.

Автор

  • Anil Kumar Muraleedharan (@amuraleedhar)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/cnos_facts_module.html

Spec-Zone.ru

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