nxos_system - Управление системными атрибутами на устройствах Cisco NXOS
Новая в версии 2.3.
Обзор
- Этот модуль предоставляет декларативное управление атрибутами системы узла на устройствах Cisco NXOS. Он предоставляет возможность настроить параметры системы узла или удалить эти параметры из активной конфигурации устройства.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4)
| нет | нет | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| domain_lookup | нет | Включает или отключает функцию DNS-поиска в Cisco NXOS. Этот аргумент принимает логические значения. При включении система попытается разрешить имена хостов с помощью DNS, а при отключении имена хостов не будут разрешаться. | ||
| domain_name | нет | Настраивает префикс имени домена по умолчанию, который будет использоваться при указании этого узла по его полному доменному имени (FQDN). Этот аргумент принимает либо список имен доменов, либо список словарей, которые настраивают имя домена и имя VRF. См. примеры. | ||
| domain_search | нет | Настраивает список суффиксов имен доменов для поиска при выполнении разрешения имен DNS. Этот аргумент принимает либо список имен доменов, либо список словарей, которые настраивают имя домена и имя VRF. См. примеры. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| hostname | нет | Настройка параметра имени устройства (hostname). Этот параметр принимает строковое значение ASCII. | ||
| name_servers | нет | Список DNS-серверов по IP-адресу, используемых для выполнения поиска разрешения имен. Этот аргумент принимает либо список DNS-серверов, либо список словарей, которые настраивают имя сервера и имя VRF. См. примеры. | ||
| password | нет | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует соответствующему стандартному порту транспорта, если он не задан в задаче (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, варианты и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Состояние значений конфигурации в текущей активной конфигурации устройства. При значении present значения должны быть настроены в активной конфигурации устройства, а при значении absent — нет. |
| system_mtu | нет | Указывает mtu, должно быть целым числом. | ||
| timeout (добавлен в 2.3)
| нет | 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает transport для использования SSL, если значение true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с использованием самозаверяющих сертификатов. Если аргумент transport не nxapi, это значение игнорируется. |
Примеры
- name: configure hostname and domain-name
nxos_system:
hostname: nxos01
domain_name: test.example.com
- name: remove configuration
nxos_system:
state: absent
- name: configure name servers
nxos_system:
name_servers:
- 8.8.8.8
- 8.8.4.4
- name: configure name servers with VRF support
nxos_system:
name_servers:
- { server: 8.8.8.8, vrf: mgmt }
- { server: 8.8.4.4, vrf: mgmt }
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| commands | Список команд конфигурации для отправки на устройство. | всегда | список | ['hostname nxos01', 'ip domain-name test.example.com'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля 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/nxos_system_module.html
