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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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-серверов в виде полных доменных имён (FQDN) или IP-адресов для выполнения поиска разрешения имён. Этот аргумент принимает список DNS-серверов. См. примеры.
state строка	Состояние значений конфигурации в текущей активной конфигурации устройства. При значении present значения должны быть настроены в активной конфигурации устройства, а при значении absent — нет. Варианты: `"present"` ← (по умолчанию) `"absent"`
vrf строка	Имя VRF для служб домена По умолчанию: `"default"`

Примечания

Примечание

Этот модуль работает с подключением network_cli и netconf. См. Параметры платформы IOS-XR.
Операция name-servers state=absent с транспортом netconf — успешна, но с rpc-ошибкой. Это связано с проблемой платформы 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/iosxr/iosxr_system_module.html