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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 словарь	Словарь с параметрами имени хоста
hostname строка	Имя хоста системы
running_config строка	Этот параметр используется только со значением parsed. Значение этого параметра должно быть выводом устройства EOS, полученным с помощью команды show running-config \| section 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 \| 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 словарь	Результирующая конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"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 eost_test"]`
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 список / элементы=строка	Предоставленная конфигурация, преобразованная в формат команд CLI устройства (оффлайн). Возвращается: когда state — `rendered` Пример: `["hostname eost_test"]`

Авторы

Gomathi Selvi Srinivasan (@GomathiselviS)

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

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