ios_system — Управление системными атрибутами на устройствах Cisco IOS
Новое в версии 2.3.
Описание
- Этот модуль обеспечивает декларативное управление атрибутами систем узлов на устройствах Cisco IOS. Он предоставляет возможность настроить параметры системы хоста или удалить эти параметры из активной конфигурации устройства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass |
Устарело
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli и become: yes с become_pass. Для получения дополнительной информации, обратитесь к руководству IOS Platform Options.
Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной среды
ANSIBLE_NET_AUTH_PASS.
|
||
| authorize bool |
|
Устарело
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli и become: yes. Для получения дополнительной информации, обратитесь к руководству IOS Platform Options.
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды
ANSIBLE_NET_AUTHORIZE. |
|
| domain_name | Настройте имя домена IP на удалённом устройстве на предоставленное значение. Значение должно быть в формате точки с запятой и будет добавлено к hostname, чтобы создать полное доменное имя. |
||
| domain_search | Предоставляет список суффиксов домена для добавления к имени хоста в целях разрешения имён. Этот аргумент принимает список имён и будет согласован с текущей активной конфигурацией на рабочем узле. | ||
| hostname | Настройте параметр имени хоста устройства. Этот параметр принимает значение ASCII-строки. | ||
| lookup_enabled bool |
|
Административный контроль для включения или выключения разрешения DNS-поисков. Когда этот аргумент установлен в True, выполняется поиск, а когда в False, поиск не выполняется. | |
| lookup_source | Предоставляет один или несколько исходных интерфейсов для выполнения DNS-поисков. Интерфейс, предоставленный в lookup_source, должен быть валидным интерфейсом, настроенным на устройстве. |
||
| name_servers | Список DNS-серверов по IP-адресам для использования при выполнении поиска разрешения имён. Этот аргумент принимает список DNS-серверов. См. примеры. | ||
| provider |
Устарело
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli.Для получения дополнительной информации, обратитесь к руководству IOS Platform Options.
Объект словаря, содержащий данные подключения.
|
||
| host обязательно |
Указывает имя или адрес DNS-хоста для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 |
Указывает порт, который необходимо использовать при установлении подключения к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. |
||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. |
||
| timeout | Значение по умолчанию: 10 |
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут будет превышен до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. |
||
| authorize bool |
|
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. |
|
| auth_pass | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. |
||
| state |
|
Состояние значений конфигурации в текущей активной конфигурации устройства. При установке в present значения должны быть настроены в активной конфигурации устройства, а при установке в absent значения не должны быть в активной конфигурации устройства. | |
Примечания
Примечание
- Тестировалось на IOS 15.6
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- 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 list |
всегда | Список команд режима конфигурации для отправки устройству Пример: ['hostname ios01', 'ip domain name test.example.com'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он обслуживается Ansible Network Team. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также обслуживаемых Ansible Network Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний
Автор
- Peter Sprygada (@privateip)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/ios_system_module.html
