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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Шифровать системные пароли Варианты: `false` `true`
password_recovery boolean	Восстановление пароля Варианты: `false` `true` ← (по умолчанию)
private_config_encryption boolean	Включить шифрование файла частной конфигурации Варианты: `false` `true`
prompt boolean	Включить приглашение, зависящее от режима Варианты: `false` `true` ← (по умолчанию)
pt_vty_logging boolean	Записывать в журнал важные события VTY-Async Варианты: `false` `true`
scripting boolean	Сценарии Варианты: `false` `true`
sequence_numbers boolean	Добавлять порядковый номер к сообщениям журнала Варианты: `false` `true`
slave_coredump boolean	Дамп ядра для ведомого устройства Варианты: `false` `true`
slave_log boolean	Включить ведение журнала для ведомых IP-устройств Варианты: `false` `true` ← (по умолчанию)
tcp_keepalives_in boolean	Отправлять контрольные пакеты через неактивные входящие сетевые соединения Варианты: `false` `true`
tcp_keepalives_out boolean	Отправлять контрольные пакеты через неактивные исходящие сетевые соединения Варианты: `false` `true`
tcp_small_servers dictionary	Малые TCP-серверы — это серверы (демоны, говоря языком Unix), работающие на маршрутизаторе и полезные для диагностики.
enable boolean	Включить малые TCP-серверы (например, ECHO) Варианты: `false` `true`
max_servers integer	Задать число разрешенных малых TCP-серверов От 1 до 2147483647
no_limit boolean	Не ограничивать число разрешенных малых TCP-серверов Варианты: `false` `true`
telnet_zeroidle boolean	Установить нулевое значение окна TCP при простое соединения Варианты: `false` `true`
timestamps list / elements=dictionary	Добавлять временные метки к отладочным сообщениям и сообщениям журнала
datetime_options dictionary	Параметры временной метки даты и времени
localtime boolean	Использовать местный часовой пояс для временных меток Варианты: `false` `true`
msec boolean	Включать миллисекунды во временную метку Варианты: `false` `true`
show_timezone boolean	Добавлять сведения о часовом поясе во временную метку Варианты: `false` `true`
year boolean	Включать год во временную метку Варианты: `false` `true`
enable boolean	Включить временную метку для выбранного сообщения Варианты: `false` `true`
msg string	Добавлять временную метку к сообщениям журнала или отладки Варианты: `"debug"` `"log"`
timestamp string	Временная метка с датой и временем или с временем работы системы Варианты: `"datetime"` `"uptime"`
udp_small_servers dictionary	Малые UDP-серверы — это серверы (демоны, говоря языком Unix), работающие на маршрутизаторе и полезные для диагностики.
enable boolean	Включить малые UDP-серверы (например, ECHO) Варианты: `false` `true`
max_servers integer	Задать число разрешенных малых UDP-серверов От 1 до 2147483647
no_limit boolean	Не ограничивать число разрешенных малых UDP-серверов Варианты: `false` `true`
unsupported_transceiver boolean	Включить поддержку трансиверов сторонних производителей Варианты: `false` `true`
running_config string	Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный от устройства IOS при выполнении команды show running-config \| section ^service\|^no service. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует ее в структурированные данные Ansible согласно спецификации аргументов модуля ресурсов; затем значение возвращается в ключе parsed результата.
state string	Состояние, в котором должна остаться конфигурация. Модуль ведет себя декларативно одинаково для состояний replaced и overridden. Дополнительные сведения см. в примерах. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"gathered"` `"rendered"` `"parsed"`

Примечания

Примечание

Проверено на Cisco IOSXE версии 17.9.1a в CML.
Этот модуль работает с подключением 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 dictionary	Конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"This output will always be in the same format as the module argspec.\n"`
before dictionary	Конфигурация до выполнения модуля. Возвращается: когда state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands list / elements=string	Набор команд, отправленных на удалённое устройство. Возвращается: когда state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `["no service config", "service tcp-keepalives-in", "service tcp-keepalives-out"]`
gathered list / elements=string	Сведения о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных. Возвращается: когда state имеет значение `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed list / elements=string	Собственная конфигурация устройства, переданная в параметре running_config и разобранная в структурированные данные согласно спецификации аргументов модуля. Возвращается: когда state имеет значение `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered list / elements=string	Конфигурация, указанная в задаче и преобразованная в собственный формат устройства (без подключения к устройству). Возвращается: когда state имеет значение `rendered` Пример: `["service dhcp", "service password-encryption", "service password-recovery", "service prompt config", "service slave-log"]`

Авторы

Ambroise Rosset (@earendilfr)
Sagar Paul (@KB-perByte)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/ios/ios_service_module.html