junipernetworks.junos.junos_hostname модуль — Управление конфигурацией сервера имени узла на устройствах Junos.

Примечание

Этот модуль входит в коллекцию junipernetworks.junos (версия 8.0.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install junipernetworks.junos. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: junipernetworks.junos.junos_hostname.

Новый в junipernetworks.junos 2.9.0

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

Описание

Этот модуль управляет конфигурацией имени узла на устройствах, работающих под управлением Junos.

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

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

ncclient (>=v0.6.4)
xmltodict (>=0.12.0)

Параметры

Параметр	Комментарии
config словарь	Словарь конфигурации имени системы узла.
hostname строка	Укажите имя узла.
running_config строка	Этот параметр используется только со значением состояния parsed. Значение этого параметра должно быть результатом выполнения команды show system hostname на устройстве Junos. Состояние 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 system hostname, выполненной на устройстве. Для состояния parsed активное подключение к удалённому хосту не требуется. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"deleted"` `"overridden"` `"parsed"` `"gathered"` `"rendered"`

Примечания

Примечание

Для работы этого модуля требуется включенная сетевая служба netconf на управляемом устройстве.
Этот модуль работает с подключением netconf.
См. опции платформы Junos OS.
Тестировалось на JunOS v18.4R1

Примеры

# Using merged
#
# Before state
# ------------
#
# vagrant@vsrx# show system hostname
#
# [edit]
- name: Merge provided HOSTNAME configuration into running configuration.
  junipernetworks.junos.junos_hostname:
    config:
      hostname: 'vsrx-18.4R1'
    state: merged
#
# -------------------------
# Module Execution Result
# -------------------------
#     "after": {
#         "hostname": "vsrx-18.4R1"
#     },
#     "before": {},
#     "changed": true,
#     "commands": [
#           "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
#           "<nc:host-name>vsrx-18.4R1</nc:host-name></nc:system>"
#     ]
# After state
# -----------
#
# vagrant@vsrx-18.4R1# show system host-name
# host-name vsrx-18.4R1;
#
# Using replaced
#
# Before state
# ------------
#
# vagrant@vsrx-18.4R1# show system host-name
# host-name vsrx-18.4R1;
#
# [edit]
- name: Replaced target config with provided config.
  junipernetworks.junos.junos_hostname:
    config:
      hostname: 'vsrx-12'
    state: replaced
#
# -------------------------
# Module Execution Result
# -------------------------
#     "after": {
#         "hostname": "vsrx-12"
#     },
#     "before": {
#         "hostname": "vsrx-18.4R1"
#     },
#     "changed": true,
#     "commands": [
#           "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
#           "<nc:host-name>vsrx-12</nc:host-name></nc:system>"
#     ]
# After state
# -----------
#
# vagrant@vsrx-18.4R1# show system host-name
# host-name vsrx-12;
#
# Using overridden
#
# Before state
# ------------
#
# vagrant@vsrx-18.4R1# show system host-name
# host-name vsrx-18.4R1;
#
# [edit]
- name: Replaced target config with provided config.
  junipernetworks.junos.junos_hostname:
    config:
      hostname: 'vsrx-12'
    state: overridden
#
# -------------------------
# Module Execution Result
# -------------------------
#     "after": {
#         "hostname": "vsrx-12"
#     },
#     "before": {
#         "hostname": "vsrx-18.4R1"
#     },
#     "changed": true,
#     "commands": [
#           "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
#           "<nc:host-name>vsrx-12</nc:host-name></nc:system>"
#     ]
# After state
# -----------
#
# vagrant@vsrx-18.4R1# show system host-name
# host-name vsrx-12;
#
# Using deleted
#
# Before state
# ------------
#
# vagrant@vsrx-18.4R1# show system host-name
# host-name vsrx-12;
#
- name: Delete running HOSTNAME global configuration
  junipernetworks.junos.junos_hostname:
    config:
    state: deleted
#
# -------------------------
# Module Execution Result
# -------------------------
#     "after": {},
#     "before": {
#         "hostname": "vsrx-12"
#     },
#     "changed": true,
#     "commands": [
#               "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
#                <nc:host-name delete="delete"/></nc:system>"
#     ]
# After state
# -----------
#
# vagrant@vsrx# show system ntp
#
# [edit]
# Using gathered
#
# Before state
# ------------
#
# vagrant@vsrx-18.4R1# show system host-name
# host-name vsrx-12;
#
- name: Gather running HOSTNAME global configuration
  junipernetworks.junos.junos_hostname:
    state: gathered
#
# -------------------------
# Module Execution Result
# -------------------------
#     "gathered": {
#         "hostname": "vsrx-12",
#     },
#     "changed": false,
# Using rendered
#
# Before state
# ------------
#
- name: Render xml for provided facts.
  junipernetworks.junos.junos_hostname:
    config:
      boot_server: '78.46.194.186'
    state: rendered
#
# -------------------------
# Module Execution Result
# -------------------------
#     "rendered": [
#           "<nc:system xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">"
#           "<nc:host-name>78.46.194.186</nc:host-name></nc:system>"
#     ]
#
# Using parsed
# parsed.cfg
# ------------
# <?xml version="1.0" encoding="UTF-8"?>
# <rpc-reply message-id="urn:uuid:0cadb4e8-5bba-47f4-986e-72906227007f">
#     <configuration changed-seconds="1590139550" changed-localtime="2020-05-22 09:25:50 UTC">
#         <version>18.4R1-S2.4</version>
#         <system xmlns="http://yang.juniper.net/junos-es/conf/system">
#            <host-name>vsrx-18.4R1</host-name>
#         </system>
#     </configuration>
# </rpc-reply>
#
- name: Parse HOSTNAME running config
  junipernetworks.junos.junos_hostname:
    running_config: "{{ lookup('file', './parsed.cfg') }}"
    state: parsed
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
#
# "parsed":  {
#         "hostname": "vsrx-18.4R1"
#     }
#

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

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

Ключ	Описание
after словарь	Вызов результирующей модели конфигурации. Возвращается: при изменении Пример: `"The configuration returned will always be in the same format\n of the parameters above.\n"`
before словарь	Конфигурация до вызова модели. Возвращается: всегда Пример: `"The configuration returned will always be in the same format\n of the parameters above.\n"`
commands список / элементы=строка	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["\"<nc:host-name>78.46.194.186</nc:host-name></nc:system>\""]`

Авторы

Rohit Thakur (@rohitthakur2590)

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

© 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/junipernetworks/junos/junos_hostname_module.html