cisco.iosxr.iosxr_system module — модуль для управления атрибутами системы.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.iosxr.iosxr_system.

Добавлено в cisco.iosxr 1.0.0

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

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

Этот модуль обеспечивает декларативное управление системными атрибутами узла на устройствах Cisco IOS XR. Он позволяет настраивать параметры хост-системы или удалять их из активной конфигурации устройства.

Примечание

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

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

Требования

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

ncclient >= 0.5.3 при использовании netconf
lxml >= 4.1.1 при использовании netconf

Параметры

Параметр	Комментарии
domain_name строка	Задаёт на удалённом устройстве указанное доменное имя IP. Значение должно иметь формат имени с точками и будет добавлено к `hostname`, чтобы сформировать полное доменное имя.
domain_search список / элементы=строка	Список суффиксов домена, добавляемых к имени хоста для разрешения имён. Этот аргумент принимает список имён и синхронизирует его с текущей активной конфигурацией работающего узла.
hostname строка	Задаёт параметр имени хоста устройства. Этот параметр принимает строковое значение ASCII.
lookup_enabled логическое значение	Позволяет административно включать и отключать поиск DNS. Если этому аргументу присвоено значение True, поиск выполняется; если False — не выполняется. Варианты: `false` `true` ← (по умолчанию)
lookup_source строка	Аргумент `lookup_source` задаёт один или несколько исходных интерфейсов для поиска DNS. Интерфейс, указанный в `lookup_source`, должен быть допустимым интерфейсом, настроенным на устройстве.
name_servers список / элементы=строка	Аргумент `name_serves` принимает список DNS-серверов имён, указанных в виде полных доменных имён или IP-адресов, для разрешения имён. Этот аргумент принимает список DNS-серверов. См. примеры.
state строка	Состояние значений конфигурации в текущей активной конфигурации устройства. Если задано present, значения должны присутствовать в активной конфигурации устройства; если задано absent, они не должны в ней присутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
vrf строка	Имя VRF для доменных служб По умолчанию: `"default"`

Примечания

Примечание

Этот модуль работает с подключениями network_cli и netconf. См. параметры платформы IOS-XR.
Операция name-servers state=absent с транспортом netconf завершается успешно, но возвращает rpc-error. Это связано с проблемой платформы XR. В качестве обходного решения рекомендуется использовать в задаче параметр ignore_errors.
Подробнее об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <network_guide>`
Подробнее об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: configure hostname and domain-name (default vrf=default)
  cisco.iosxr.iosxr_system:
    hostname: iosxr01
    domain_name: test.example.com
    domain_search:
      - ansible.com
      - redhat.com
      - cisco.com
- name: remove configuration
  cisco.iosxr.iosxr_system:
    hostname: iosxr01
    domain_name: test.example.com
    domain_search:
      - ansible.com
      - redhat.com
      - cisco.com
    state: absent
- name: configure hostname and domain-name with vrf
  cisco.iosxr.iosxr_system:
    hostname: iosxr01
    vrf: nondefault
    domain_name: test.example.com
    domain_search:
      - ansible.com
      - redhat.com
      - cisco.com
- name: configure DNS lookup sources
  cisco.iosxr.iosxr_system:
    lookup_source: MgmtEth0/0/CPU0/0
    lookup_enabled: true
- name: configure name servers
  cisco.iosxr.iosxr_system:
    name_servers:
      - 8.8.8.8
      - 8.8.4.4

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

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

Ключ	Описание
commands список / элементы=строка	Список команд режима конфигурации, отправляемых устройству Возвращается: всегда Пример: `["hostname iosxr01", "ip domain-name test.example.com"]`
xml список / элементы=строка	XML-запрос NetConf rpc, отправленный устройству с транспортом `netconf` Возвращается: всегда (пустой список, если XML rpc не отправляется) Пример: `["<config xmlns:xc=\"urn:ietf:params:xml:ns:netconf:base:1.0\"> <ip-domain xmlns=\"http://cisco.com/ns/yang/Cisco-IOS-XR-ip-domain-cfg\"> <vrfs> <vrf> <vrf-name>default</vrf-name> <lists> <list xc:operation=\"merge\"> <order>0</order> <list-name>redhat.com</list-name> </list> </lists> </vrf> </vrfs> </ip-domain> </config>"]`

Ключ

Описание

commands

список / элементы=строка

Список команд режима конфигурации, отправляемых устройству

Возвращается: всегда

Пример: ["hostname iosxr01", "ip domain-name test.example.com"]

xml

список / элементы=строка

XML-запрос NetConf rpc, отправленный устройству с транспортом netconf

Возвращается: всегда (пустой список, если XML rpc не отправляется)

Пример: ["<config xmlns:xc=\"urn:ietf:params:xml:ns:netconf:base:1.0\"> <ip-domain xmlns=\"http://cisco.com/ns/yang/Cisco-IOS-XR-ip-domain-cfg\"> <vrfs> <vrf> <vrf-name>default</vrf-name> <lists> <list xc:operation=\"merge\"> <order>0</order> <list-name>redhat.com</list-name> </list> </lists> </vrf> </vrfs> </ip-domain> </config>"]

Авторы

Peter Sprygada (@privateip)
Kedar Kekan (@kedarX)

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

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