Модуль arista.eos.eos_hostname — управление ресурсом имени хоста

Примечание

Этот модуль входит в коллекцию arista.eos (версия 12.1.2).

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

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

Чтобы использовать коллекцию в плейбуке, укажите: arista.eos.eos_hostname.

Добавлено в arista.eos 4.1.0

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

Краткое описание

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

Примечание

Этому модулю соответствует плагин действий.

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

Параметры

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

Примечания

Примечание

Проверено на Arista EOS 4.24.60M
Этот модуль работает с подключением network_cli. См. параметры платформы EOS.

Примеры

# Using state: merged
# Before state:
# -------------
# test#show running-config | section ^hostname
# hostname eos
# Merged play:
# ------------
- name: Apply the provided configuration
  arista.eos.eos_hostname:
    config:
      hostname: eos
    state: merged
# Commands Fired:
# ---------------
# "commands": [
#         "hostname eos",
# ],
# After state:
# ------------
# test#show running-config | section ^hostname
# hostname eos


# Using state: deleted
# Before state:
# -------------
# test#show running-config | section ^hostname
# hostname eosTest
# Deleted play:
# -------------
- name: Remove all existing configuration
  arista.eos.eos_hostname:
    state: deleted
# Commands Fired:
# ---------------
# "commands": [
#     "no hostname eosTest",
# ],
# After state:
# ------------
# test#show running-config | section ^hostname
# hostname eos


# Using state: overridden
# Before state:
# -------------
# test#show running-config | section ^hostname
# hostname eos
# Overridden play:
# ----------------
- name: Override commands with provided configuration
  arista.eos.eos_hostname:
    config:
      hostname: eosTest
    state: overridden
# Commands Fired:
# ---------------
# "commands": [
#       "hostname eosTest",
#     ],
# After state:
# ------------
# test#show running-config | section ^hostname
# hostname eosTest


# Using state: replaced
# Before state:
# -------------
# test#show running-config | section ^hostname
# hostname eosTest
# Replaced play:
# --------------
- name: Replace commands with provided configuration
  arista.eos.eos_hostname:
    config:
      hostname: eosTest
    state: replaced
# Commands Fired:
# ---------------
# "commands": [],
# After state:
# ------------
# test#show running-config | section ^hostname
# hostname eosTest

# Using state: gathered
# Before state:
# -------------
# test#show running-config | section ^hostname
# hostname eosTest
# Gathered play:
# --------------
- name: Gather listed hostname config
  arista.eos.eos_hostname:
    state: gathered
# Module Execution Result:
# ------------------------
#   "gathered": {
#      "hostname": "eosTest"
#     },

# Using state: rendered
# Rendered play:
# --------------
- name: Render the commands for provided configuration
  arista.eos.eos_hostname:
    config:
      hostname: eosTest
    state: rendered
# Module Execution Result:
# ------------------------
# "rendered": [
#     "hostname eosTest",
# ]

# Using state: parsed
# File: parsed.cfg
# ----------------
# hostname eosTest
# Parsed play:
# ------------
- name: Parse the provided configuration with the existing running configuration
  arista.eos.eos_hostname:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed
# Module Execution Result:
# ------------------------
#  "parsed": {
#     "hostname": "eosTest"
# }

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

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

Ключ	Описание
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` Пример: `["hostname eost_test"]`
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` Пример: `["hostname eost_test"]`

Авторы

Gomathi Selvi Srinivasan (@GomathiselviS)

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

© 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/arista/eos/eos_hostname_module.html