Spec-Zone.ru › Ansible 2.4

ios_system - Управление системными атрибутами на устройствах Cisco IOS

Новая версия с 2.3.

  • Обзор
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Обзор

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

Параметры

параметр обязательный по умолчанию выбор комментарии
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
нет
  • да
  • нет
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
domain_name
нет
Настройте имя домена IP на удалённом устройстве на указанное значение. Значение должно быть в формате имени с точками и будет добавлено к hostname, чтобы создать полное доменное имя.
domain_search
нет
Предоставляет список суффиксов домена для добавления к имени хоста в целях разрешения имён. Этот аргумент принимает список имён и будет согласован с текущей активной конфигурацией на узле.
hostname
нет
Настройте параметр имени хоста устройства. Этот параметр принимает значение ASCII-строки.
lookup_enabled
нет
  • да
  • нет
Административный контроль включения или выключения поиска DNS. Когда этот аргумент установлен в True, поиск выполняется, а когда он установлен в False, поиск не выполняется.
lookup_source
нет
Предоставляет один или несколько интерфейсов источника для использования при выполнении поиска DNS. Интерфейс, предоставленный в lookup_source, должен быть валидным интерфейсом, настроенным на устройстве.
name_servers
нет
Список DNS-серверов по IP-адресу для использования в поиске разрешения имён. Этот аргумент принимает либо список DNS-серверов. См. примеры.
provider
нет
Объект словаря, содержащий сведения о подключении.
Объект словаря provider
параметр обязательный по умолчанию выбор комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
authorize
нет
  • да
  • нет
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
auth_pass
нет нет
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
host
да
Указывает DNS-имя хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
timeout
нет 10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
password
нет
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для подключения к удалённому устройству.
state
нет present
  • present
  • absent
Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в present значения должны быть настроены в активной конфигурации устройства, а при установке в absent значения не должны быть в активной конфигурации устройства

Примеры

- name: configure hostname and domain name
  ios_system:
    hostname: ios01
    domain_name: test.example.com
    domain-search:
      - ansible.com
      - redhat.com
      - cisco.com

- name: remove configuration
  ios_system:
    state: absent

- name: configure DNS lookup sources
  ios_system:
    lookup_source: MgmtEth0/0/CPU0/0
    lookup_enabled: yes

- name: configure name servers
  ios_system:
    name_servers:
      - 8.8.8.8
      - 8.8.4.4

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

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

имя описание возвращаемое тип пример
commands
Список команд конфигурации для отправки на устройство
всегда список ['hostname ios01', 'ip domain name test.example.com']

Примечания

Примечание

  • Проверено на IOS 15.6

Статус

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

Информация о техническом обслуживании

Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Информацию о сообществе и о внесении вклада, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ios_system_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API