Spec-Zone.ru › Ansible 2.7

nxos_igmp – Управляет глобальной конфигурацией IGMP.

Новая версия 2.2.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Управляет параметрами глобальной конфигурации IGMP.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
enforce_rtr_alert
логическое значение
    Варианты:
  • no
  • yes
Включает или отключает проверку параметра enforce router alert для пакетов IGMPv2 и IGMPv3.
flush_routes
логическое значение
    Варианты:
  • no
  • yes
Удаляет маршруты при перезапуске процесса IGMP. По умолчанию маршруты не очищаются.
provider
-
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр необходим только при использовании NX-API.
Для получения дополнительной информации см. руководство по параметрам платформы NXOS NXOS Platform Options.
Объект словаря, содержащий данные подключения.
auth_pass
-
добавлен в 2.5.3
Значение по умолчанию:
"none"
Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
логическое значение
добавлен в 2.5.3
    Варианты:
  • no ←
  • yes
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
- / обязательно
Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта.
password
-
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
-
Значение по умолчанию:
"0 (использовать стандартный порт)"
Указывает порт для подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Если порт не указан в задаче, используется соответствующий стандартный порт транспорта (cli=22, http=80, https=443).
ssh_keyfile
-
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
-
добавлен в 2.3
Значение по умолчанию:
10
Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль возвращает ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т. д.).
transport
- / обязательно
Значение по умолчанию:
"cli"
Устанавливает транспортное подключение для соединения с удаленным устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_proxy
логическое значение
добавлен в 2.5
    Варианты:
  • no
  • yes ←
Если no, переменные окружения http_proxy и https_proxy будут игнорироваться.
use_ssl
логическое значение
    Варианты:
  • no ←
  • yes
Устанавливает использование SSL для транспорта, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется.
username
-
Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
validate_certs
логическое значение
    Варианты:
  • no
  • yes
Если no, сертификаты SSL не будут проверены. Это следует использовать только на управляемых лично сайтах с самозаверяющими сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
restart
логическое значение
    Варианты:
  • no
  • yes
Перезапускает процесс igmp (используя команду exec config).
state
-
    Варианты:
  • present ←
  • default
Управляет желаемым состоянием ресурса.

Примечания

Примечание

  • Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL.
  • При state=default, все поддерживаемые параметры будут сброшены до состояния по умолчанию.
  • Если restart установлено в true вместе с другими параметрами, перезапуск произойдёт последним, т. е. после выполнения конфигурации.
  • Для получения информации об использовании CLI и NX-API см. руководство по параметрам платформы NXOS
  • Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. сетевое руководство Ansible
  • Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco Cisco integration.

Примеры

- name: Default igmp global params (all params except restart)
  nxos_igmp:
    state: default

- name: Ensure the following igmp global config exists on the device
  nxos_igmp:
    flush_routes: true
    enforce_rtr_alert: true

- name: Restart the igmp process
  nxos_igmp:
    restart: true

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

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

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

Пример:
['ip igmp flush-routes']


Статус

  • Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Данный модуль поддерживается командой Ansible Network. [сетевой]

Поддержка Red Hat

Дополнительную информацию о поддержке Red Hat этого модуля можно найти в этой статье базы знаний Red Hat Red Hat Knowledge Base.

Авторы

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

Подсказка

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

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

Spec-Zone.ru

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