cisco.ios.ios_service модуль — Модуль ресурсов для настройки службы.

Примечание

Этот модуль является частью коллекции cisco.ios (версия 8.0.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.ios.

Чтобы использовать её в плейбуке, укажите: cisco.ios.ios_service.

Добавлена в cisco.ios 4.6.0

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

Обзор

Этот модуль настраивает и управляет атрибутами службы на платформах IOS

Псевдонимы: service

Параметры

Параметр	Комментарии
config dictionary	Словарь конфигурации сервиса
call_home boolean	Сервис Cisco call-home Варианты: `false` `true`
compress_config boolean	Сжать файл конфигурации nvram Варианты: `false` `true`
config boolean	Загрузка файлов конфигурации TFTP Варианты: `false` `true`
counters integer	Управление старением счетчиков интерфейса путем установки максимального порогового значения старения счетчика По умолчанию: `0`
dhcp boolean	Включить DHCP-сервер и агент ретрансляции Варианты: `false` `true` ← (по умолчанию)
disable_ip_fast_frag boolean	Отключить быструю фрагментацию на основе частиц IP Варианты: `false` `true`
exec_callback boolean	Включить обратный вызов exec Варианты: `false` `true`
exec_wait boolean	Задержка запуска EXEC на шумных линиях Варианты: `false` `true`
hide_telnet_addresses boolean	Скрыть адреса назначения в команде telnet Варианты: `false` `true`
internal boolean	Включить/Отключить внутренние команды Варианты: `false` `true`
linenumber boolean	Включить баннер номера строки для каждого exec Варианты: `false` `true`
log boolean	Логирование трассировки стека Варианты: `false` `true`
log_hidden boolean	Включить сообщения syslog для скрытых/внутренних команд Варианты: `false` `true`
nagle boolean	Включить алгоритм контроля загрузки Нейгла Варианты: `false` `true`
old_slip_prompts boolean	Разрешить старым скриптам работать с slip/ppp Варианты: `false` `true`
pad boolean	Включить команды PAD Варианты: `false` `true`
pad_cmns boolean	Включить PAD через соединения CMNS Варианты: `false` `true`
pad_from_xot boolean	Принимать соединения XOT к PAD Варианты: `false` `true`
pad_to_xot boolean	Разрешить исходящие соединения PAD через XOT Варианты: `false` `true`

password_encryption boolean	Шифрование системных паролей Choices: `false` `true`
password_recovery boolean	Восстановление пароля Choices: `false` `true` ← (default)
private_config_encryption boolean	Включить шифрование файла конфигурации Choices: `false` `true`
prompt boolean	Включить приглашение, специфичное для режима Choices: `false` `true` ← (default)
pt_vty_logging boolean	Логирование важных событий VTY-Async Choices: `false` `true`
scripting boolean	Скриптинг Choices: `false` `true`
sequence_numbers boolean	Проставлять сообщения регистратора порядковым номером Choices: `false` `true`
slave_coredump boolean	slave-coredump Choices: `false` `true`
slave_log boolean	Включить возможность ведения журнала для вспомогательных IP-адресов Choices: `false` `true` ← (default)
tcp_keepalives_in boolean	Генерировать keepalives для неактивных входящих сетевых соединений Choices: `false` `true`
tcp_keepalives_out boolean	Генерировать keepalives для неактивных исходящих сетевых соединений Choices: `false` `true`
tcp_small_servers dictionary	Небольшие серверы TCP и UDP — это серверы (демон, в терминах Unix), работающие в маршрутизаторе, которые полезны для диагностики.
enable boolean	Включить небольшие TCP-серверы (например, ECHO) Choices: `false` `true`
max_servers string	Установить количество допустимых небольших TCP-серверов от 1 до 2147483647 или no-limit
telnet_zeroidle boolean	Установить TCP-окно 0, когда соединение неактивно Choices: `false` `true`
timestamps list / elements=dictionary	Отметки времени в сообщениях отладки/журнала
datetime_options dictionary	Параметры для отметки даты и времени
localtime boolean	Использовать местный часовой пояс для меток времени Choices: `false` `true`
msec boolean	Включать миллисекунды в метку времени Choices: `false` `true`
show_timezone boolean	Добавить информацию о часовом поясе к метке времени Choices: `false` `true`

год boolean	Включать год в метку времени Варианты: `false` `true`
включить boolean	Включить метку времени для выбранного сообщения Варианты: `false` `true`
сообщ строка	Временная метка для журнальных или отладочных сообщений Варианты: `"debug"` `"log"`
метка_времени строка	Метка времени с датой и временем или с временем работы системы Варианты: `"datetime"` `"uptime"`
udp_small_servers словарь	Малые серверы TCP и UDP — это серверы (демоны в терминологии Unix), работающие на маршрутизаторе, которые полезны для диагностики.
включить boolean	Включить малые серверы UDP (например, ECHO) Варианты: `false` `true`
max_servers строка	Установить количество разрешённых малых TCP-серверов От 1 до 2147483647 или без ограничения
unsupported_transceiver boolean	Включить поддержку трансиверов сторонних производителей Варианты: `false` `true`
running_config строка	Этот параметр используется только со значением parsed. Значение этого параметра должно быть результатом выполнения команды show running-config \| section ^service\|^no service на устройстве IOS. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует её в структурированные данные Ansible, соответствующие argspec модуля ресурсов. Затем значение возвращается в ключе parsed в результате.
состояние строка	Состояние, в котором должна остаться конфигурация. Модуль имеет декларативно аналогичное поведение для состояний replaced и overridden. Дополнительные сведения см. в примерах. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"gathered"` `"rendered"` `"parsed"`

Примечания

Примечание

Проверено на Cisco IOSXE версии 16.9
Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html

Примеры

# Using merged

# Before state:
# -------------

# router-ios#show running-config all | section ^service
# service slave-log
# service timestamps debug datetime msec
# service timestamps log datetime msec
# service private-config-encryption
# service prompt config
# service counters max age 0
# service dhcp
# service call-home
# service password-recovery

- name: Merge provided configuration with device configuration
  cisco.ios.ios_service:
    config:
      tcp_keepalives_in: true
      tcp_keepalives_out: true
      timestamps:
        - msg: debug
          enable: true
          timestamp: datetime
        - msg: log
          enable: true
          timestamp: datetime
      pad: false
      password_encryption: true
    state: merged

# Task Output
# -----------
#
# before:
#   call_home: true
#   counters: 0
#   dhcp: true
#   password_recovery: true
#   private_config_encryption: true
#   prompt: true
#   slave_log: true
#   timestamps:
#   - datetime_options:
#       msec: true
#     msg: debug
#     timestamp: datetime
#   - datetime_options:
#       msec: true
#     msg: log
#     timestamp: datetime
# commands:
# - service password-encryption
# - service tcp-keepalives-in
# - service tcp-keepalives-out
# after:
#   call_home: true
#   counters: 0
#   dhcp: true
#   password_encryption: true
#   password_recovery: true
#   private_config_encryption: true
#   prompt: true
#   slave_log: true
#   tcp_keepalives_in: true
#   tcp_keepalives_out: true
#   timestamps:
#   - datetime_options:
#       msec: true
#     msg: debug
#     timestamp: datetime
#   - datetime_options:
#       msec: true
#     msg: log
#     timestamp: datetime

# After state:
# ------------

# router-ios#show running-config all | section ^service
# service slave-log
# service tcp-keepalives-in
# service tcp-keepalives-out
# service timestamps debug datetime msec
# service timestamps log datetime msec
# service password-encryption
# service private-config-encryption
# service prompt config
# service counters max age 0
# service dhcp
# service call-home
# service password-recovery

# Using replaced

# Before state:
# -------------

# router-ios#show running-config all | section ^service
# service slave-log
# service tcp-keepalives-in
# service tcp-keepalives-out
# service timestamps debug datetime msec
# service timestamps log datetime msec
# service password-encryption
# service private-config-encryption
# service prompt config
# service counters max age 0
# service dhcp
# service call-home
# service password-recovery

- name: Replaces device configuration of services with provided configuration
  cisco.ios.ios_service:
    config:
      timestamps:
        - msg: log
          enable: true
          timestamp: datetime
          datetime_options:
            localtime: true
            msec: true
            show_timezone: true
            year: true
        - msg: debug
          enable: true
          timestamp: datetime
      pad: false
      password_encryption: true
    state: "replaced"

# Task Output
# -----------
#
# before:
#   call_home: true
#   counters: 0
#   dhcp: true
#   password_encryption: true
#   password_recovery: true
#   private_config_encryption: true
#   prompt: true
#   slave_log: true
#   tcp_keepalives_in: true
#   tcp_keepalives_out: true
#   timestamps:
#   - datetime_options:
#       msec: true
#     msg: debug
#     timestamp: datetime
#   - datetime_options:
#       msec: true
#     msg: log
#     timestamp: datetime
# commands:
# - no service call-home
# - no service tcp-keepalives-in
# - no service tcp-keepalives-out
# - no service timestamps log
# - service timestamps log datetime msec localtime show-timezone year
# - no service timestamps debug
# - service timestamps debug datetime
# after:
#   counters: 0
#   dhcp: true
#   password_encryption: true
#   password_recovery: true
#   private_config_encryption: true
#   prompt: true
#   slave_log: true
#   timestamps:
#   - msg: debug
#     timestamp: datetime
#   - datetime_options:
#       localtime: true
#       msec: true
#       show_timezone: true
#       year: true
#     msg: log
#     timestamp: datetime

# After state:
# ------------

# router-ios#show running-config all | section ^service
# service slave-log
# service timestamps debug datetime
# service timestamps log datetime msec localtime show-timezone year
# service password-encryption
# service private-config-encryption
# service prompt config
# service counters max age 0
# service dhcp
# service password-recovery

# Using Deleted

# Before state:
# -------------

# router-ios#show running-config all | section ^service
# service slave-log
# service timestamps debug datetime
# service timestamps log datetime msec localtime show-timezone year
# service password-encryption
# service private-config-encryption
# service prompt config
# service counters max age 0
# service dhcp
# service password-recovery

- name: "Delete service configuration and restore default configuration for some important service (those with a default value in module)"
  cisco.ios.ios_service:
    state: deleted

# Task Output
# -----------
#
# before:
#   counters: 0
#   dhcp: true
#   password_encryption: true
#   password_recovery: true
#   private_config_encryption: true
#   prompt: true
#   slave_log: true
#   timestamps:
#   - msg: debug
#     timestamp: datetime
#   - datetime_options:
#       localtime: true
#       msec: true
#       show_timezone: true
#       year: true
#     msg: log
#     timestamp: datetime
# commands:
# - no service password-encryption
# - no service timestamps debug
# - no service timestamps log
# after:
#   counters: 0
#   dhcp: true
#   password_recovery: true
#   private_config_encryption: true
#   prompt: true
#   slave_log: true

# After state:
# ------------
#
# router-ios#show running-config all | section ^service
# service slave-log
# service private-config-encryption
# service prompt config
# service counters max age 0
# service dhcp
# service password-recovery

# Using gathered

# Before state:
# -------------
#
# router-ios#show running-config all | section ^service
# service slave-log
# service timestamps debug datetime
# service timestamps log datetime msec localtime show-timezone year
# service password-encryption
# service private-config-encryption
# service prompt config
# service counters max age 0
# service dhcp
# service password-recovery

- name: Gather facts of interfaces
  cisco.ios.ios_service:
    config:
    state: gathered

# Task Output
# -----------
#
# gathered:
#   counters: 0
#   dhcp: true
#   password_encryption: true
#   password_recovery: true
#   private_config_encryption: true
#   prompt: true
#   slave_log: true
#   timestamps:
#   - msg: debug
#     timestamp: datetime
#   - datetime_options:
#       localtime: true
#       msec: true
#       show_timezone: true
#       year: true
#     msg: log
#     timestamp: datetime

# Using rendered

- name: Render the commands for provided configuration
  cisco.ios.ios_service:
    config:
      timestamps:
        - msg: log
          enable: true
          timestamp: datetime
          datetime_options:
            localtime: true
            msec: true
            show_timezone: true
            year: true
        - msg: debug
          enable: true
          timestamp: datetime
      pad: false
      password_encryption: true
    state: rendered

# ·Task·Output
# -----------
#
# rendered:
# - service dhcp
# - service password-encryption
# - service password-recovery
# - service prompt config
# - service slave-log
# - service timestamps log datetime msec localtime show-timezone year
# - service timestamps debug datetime

# Using parsed

# File: parsed.cfg
# ----------------
#
# no service pad
# service password-encryption
# service tcp-keepalives-in
# service tcp-keepalives-out
# service timestamps debug datetime msec localtime show-timezone year
# service timestamps log datetime msec localtime show-timezone year
# service counters max age 5

- name: Parse the provided configuration
  cisco.ios.ios_service:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task Output
# -----------
#
# parsed:
#   counters: 5
#   dhcp: true
#   password_encryption: true
#   password_recovery: true
#   prompt: true
#   slave_log: true
#   tcp_keepalives_in: true
#   tcp_keepalives_out: true
#   timestamps:
#   - datetime_options:
#       localtime: true
#       msec: true
#       show_timezone: true
#       year: true
#     msg: debug
#     timestamp: datetime
#   - datetime_options:
#       localtime: true
#       msec: true
#       show_timezone: true
#       year: true
#     msg: log
#     timestamp: datetime

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

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

Ключ	Описание
after словарь	Результирующая конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"This output will always be in the same format as the module argspec.\n"`
before словарь	Конфигурация до выполнения модуля. Возвращается: когда state — `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands список / элементы=строка	Набор команд, отправленных на удаленное устройство. Возвращается: когда state — `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `["no service config", "service tcp-keepalives-in", "service tcp-keepalives-out"]`
gathered список / элементы=строка	Факты о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных. Возвращается: когда state — `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed список / элементы=строка	Родная конфигурация устройства, предоставленная в параметре running_config, разобранная в структурированные данные в соответствии с argspec модуля. Возвращается: когда state — `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered список / элементы=строка	Предоставленная конфигурация в задании, представленная в формате, понятном устройству (оффлайн). Возвращается: когда state — `rendered` Пример: `["service dhcp", "service password-encryption", "service password-recovery", "service prompt config", "service slave-log"]`

Авторы

Ambroise Rosset (@earendilfr)

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

© 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/ios/ios_service_module.html