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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.iosxr.

Для использования в плейбуке укажите: cisco.iosxr.iosxr_hostname.

Новинка в cisco.iosxr 2.7.0

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

Описание

Этот модуль настраивает и управляет атрибутами имени хоста на платформах Cisco IOSXR.

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

Параметры

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

Примечания

Примечание

Тестировалось на Cisco Iosxr 7.0.2
Этот модуль работает с подключением network_cli.

Примеры

# Using state: merged
# Before state:
# -------------

# RP/0/RP0/CPU0:ios#show running-config hostname
# Thu Jan 20 19:48:56.011 UTC
# hostname ios

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

- name: Apply the provided configuration
  cisco.iosxr.iosxr_hostname:
    config:
      hostname: Router1
    state: merged

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

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

# RP/0/0/CPU0:Router1#show running-config hostname
# Thu Jan 20 19:48:56.011 UTC
# hostname Router1


# Using state: deleted
# Before state:
# -------------

# RP/0/0/CPU0:Router1#show running-config hostname
# Thu Jan 20 19:48:56.011 UTC
# hostname Router1

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

- name: Remove all existing configuration
  cisco.iosxr.iosxr_hostname:
    state: deleted

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

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

# After state:
# ------------
# RP/0/RP0/CPU0:ios#show running-config hostname
# Thu Jan 20 19:55:12.971 UTC
# hostname ios

# Using state: overridden
# Before state:
# -------------

# RP/0/0/CPU0:ios#show running-config hostname
# hostname ios

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

- name: Override commands with provided configuration
  cisco.iosxr.iosxr_hostname:
    config:
      hostname: RouterTest
    state: overridden

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

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

# RP/0/RP0/CPU0:RouterTest#show running-config hostname
# Thu Jan 20 19:48:56.011 UTC
# hostname RouterTest

# Using state: replaced
# Before state:
# -------------

# RP/0/RP0/CPU0:RouterTest#show running-config hostname
# Thu Jan 20 19:48:56.011 UTC
# hostname RouterTest

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

- name: Replace commands with provided configuration
  cisco.iosxr.iosxr_hostname:
    config:
      hostname: RouterTest
    state: replaced

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

# After state:
# ------------
# RP/0/0/CPU0:RouterTest#show running-config hostname
# hostname RouterTest

# Using state: gathered
# Before state:
# -------------

# RP/0/RP0/CPU0:RouterTest#show running-config hostname
# Thu Jan 20 19:48:56.011 UTC
# hostname RouterTest

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

- name: Gather listed hostname config
  cisco.iosxr.iosxr_hostname:
    state: gathered

# Module Execution Result:
# ------------------------
#   "gathered": {
#      "hostname": "RouterTest"
#     },

# Using state: rendered
# Rendered play:
# --------------

- name: Render the commands for provided configuration
  cisco.iosxr.iosxr_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.iosxr.iosxr_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 Router1"]`

Авторы

Ashwini Mhatre (@amhatre)

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

© 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/iosxr/iosxr_hostname_module.html