Модуль cisco.ios.ios_hostname – модуль ресурсов для настройки имени хоста.

Примечание

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

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

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

Чтобы использовать её в книге задач, укажите: cisco.ios.ios_hostname.

Новая функция в cisco.ios 2.7.0

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

Обзор

Этот модуль предоставляет декларативное управление именем хоста на устройствах Cisco IOS.

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

Параметры

Параметр	Комментарии
config словарь	Словарь параметров имени хоста
hostname строка	установить имя хоста для IOS
running_config строка	Этот параметр используется только со значением parsed. Значение этого параметра должно соответствовать выводу устройства IOS при выполнении команды show running-config \| section ^hostname. Значение parsed считывает конфигурацию из параметра `running_config` и преобразует её в структурированные данные Ansible в соответствии с argspec модуля ресурсов, а затем возвращает значение в ключе parsed в результате.
state строка	Состояние, в котором должна остаться конфигурация Состояния rendered, gathered и parsed не выполняют никаких изменений на устройстве. Состояние rendered преобразует конфигурацию в параметре `config` в команды CLI, специфичные для платформы, которые будут возвращены в ключе rendered в результате. Для состояния rendered активное подключение к удалённому хосту не требуется. Состояния merged, replaced и overridden имеют идентичное поведение для данного модуля. Состояние gathered извлекает текущую конфигурацию с устройства и преобразует её в структурированные данные в формате, соответствующем argspec модуля ресурсов, а значение возвращается в ключе gathered в результате. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует её в формат JSON в соответствии с параметрами модуля ресурсов, а значение возвращается в ключе parsed в результате. Значение параметра `running_config` должно иметь тот же формат, что и вывод команды show running-config \| section ^hostname, выполненной на устройстве. Для состояния parsed активное подключение к удалённому хосту не требуется. Выбои: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"rendered"` `"gathered"` `"parsed"`

Примечания

Примечание

Проверено на Cisco IOSXE версии 17.3 на CML.
Этот модуль работает с подключением network_cli.

Примеры

# Using state: merged

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

# router-ios#show running-config | section ^hostname
# hostname Router

# Merged play:
# ------------

- name: Apply the provided configuration
  cisco.ios.ios_hostname:
    config:
      hostname: Router1
    state: merged

# Commands Fired:
# ---------------

# "commands": [
#         "hostname Router1",
# ],

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

# router-ios#show running-config | section ^hostname
# hostname Router1

# Using state: deleted

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

# router-ios#show running-config | section ^hostname
# hostname RouterTest

# Deleted play:
# -------------

- name: Remove all existing configuration
  cisco.ios.ios_hostname:
    state: deleted

# Commands Fired:
# ---------------

# "commands": [
#     "no hostname RouterTest",
# ],

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

# router-ios#show running-config | section ^hostname
# hostname Router

# Using state: overridden

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

# router-ios#show running-config | section ^hostname
# hostname Router

# Overridden play:
# ----------------

- name: Override commands with provided configuration
  cisco.ios.ios_hostname:
    config:
      hostname: RouterTest
    state: overridden

# Commands Fired:
# ---------------
# "commands": [
#       "hostname RouterTest",
#     ],

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

# router-ios#show running-config | section ^hostname
# hostname RouterTest

# Using state: replaced

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

# router-ios#show running-config | section ^hostname
# hostname RouterTest

# Replaced play:
# --------------

- name: Replace commands with provided configuration
  cisco.ios.ios_hostname:
    config:
      hostname: RouterTest
    state: replaced

# Commands Fired:
# ---------------

# "commands": [],

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

# router-ios#show running-config | section ^hostname
# hostname RouterTest

# Using state: gathered

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

# router-ios#show running-config | section ^hostname
# hostname RouterTest

# Gathered play:
# --------------

- name: Gather listed hostname config
  cisco.ios.ios_hostname:
    state: gathered

# Module Execution Result:
# ------------------------

#   "gathered": {
#      "hostname": "RouterTest"
#     },

# Using state: rendered

# Rendered play:
# --------------

- name: Render the commands for provided configuration
  cisco.ios.ios_hostname:
    config:
      hostname: RouterTest
    state: rendered

# Module Execution Result:
# ------------------------

# "rendered": [
#     "hostname RouterTest",
# ]

# Using state: parsed

# File: parsed.cfg
# ----------------

# hostname RouterTest

# Parsed play:
# ------------

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

# Module Execution Result:
# ------------------------

#  "parsed": {
#     "hostname": "RouterTest"
# }

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

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

Ключ	Описание
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` Пример: `["hostname Router1"]`
gathered список / элементы=строка	Данные о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных. Возвращается: когда state равен `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed список / элементы=строка	Родная конфигурация устройства, предоставленная в параметре running_config, распарсенная в структурированные данные в соответствии с параметрами модуля. Возвращается: когда state равен `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered список / элементы=строка	Предоставленная конфигурация, преобразованная в формат команд устройства (оффлайн). Возвращается: когда state равен `rendered` Пример: `["hostname Switch1"]`

Авторы

Sagar Paul (@KB-perByte)

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

© 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_hostname_module.html