nxos_user – Управление набором локальных пользователей на устройствах Nexus
Новая версия 2.3.
Обзор
- Этот модуль предоставляет декларативное управление локальными именами пользователей, настроенными на устройствах Cisco Nexus. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо набором имён пользователей в текущей конфигурации. Он также поддерживает очистку имён пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - добавлен в 2.4 | Набор объектов username, которые необходимо настроить на удаленном устройстве Cisco Nexus. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом name. псевдонимы: users, collection | ||
| configured_password - добавлен в 2.4 | Пароль, который необходимо настроить на сетевом устройстве. Пароль должен быть предоставлен в открытом виде, и он будет зашифрован на устройстве. Обратите внимание, что этот параметр отличается от provider password. | ||
| name - | Имя пользователя, которое необходимо настроить на удаленном устройстве Cisco Nexus. Этот аргумент принимает строковое значение и взаимоисключающий с аргументом aggregate. | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только если вы используете NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект dict, содержащий данные подключения. | ||
| auth_pass строка добавлен в 2.5.3 | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не имеет действия. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение добавлен в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: "0 (использовать стандартный порт)" | Указывает порт, который нужно использовать при построении подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию устанавливается на соответствующий общий порт транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число добавлен в 2.3 | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль вернет ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д). | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое значение добавлен в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает transport для использования SSL, если установлено yes только при transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| purge логическое значение |
| Аргумент purge инструктирует модуль рассматривать определение ресурса как абсолютное. Он удалит все ранее настроенные имена пользователей на устройстве, за исключением пользователя `admin`, которого нельзя удалить из-за ограничений nxos. | |
| role - | Аргумент role настраивает роль для имени пользователя в конфигурации устройства. Аргумент принимает строковое значение, определяющее имя роли. Этот аргумент не проверяет, настроен ли роль на устройстве.псевдонимы: roles | ||
| sshkey - | Аргумент sshkey определяет открытый ключ SSH, который необходимо настроить для имени пользователя. Этот аргумент принимает допустимое значение ключа SSH. | ||
| state - |
| Аргумент state настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При значении present имя пользователя должно быть настроено в активной конфигурации устройства, а при значении absent — нет. | |
| update_password - |
| Поскольку пароли зашифрованы в конфигурации устройства, этот аргумент указывает, когда изменить пароль. При значении always, пароль всегда будет обновляться на устройстве, а при значении on_create — только при создании имени пользователя. | |
Примечания
Примечание
- Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- name: create a new user
nxos_user:
name: ansible
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
state: present
- name: remove all users except admin
nxos_user:
purge: yes
- name: set multiple users role
aggregate:
- name: netop
- name: netend
role: network-operator
state: present
Значения возврата
Общие значения возвращаемых данных описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд конфигурационного режима для отправки на устройство Пример: ['name ansible', 'name ansible password password'] |
| delta строка | всегда | Время, затраченное на выполнение всех операций Пример: 0:00:10.469466 |
| end строка | всегда | Время завершения задачи Пример: 2016-11-16 10:38:25.595612 |
| start строка | всегда | Время начала задачи Пример: 2016-11-16 10:38:15.126146 |
Статус
- Гарантия обратной совместимости данного модуля не предоставляется. [превью]
- Данный модуль поддерживается командой Ansible Network Team. [сетевой]
Поддержка Red Hat
Дополнительная информация о поддержке данного модуля Red Hat доступна в этой статье базы знаний 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.8/modules/nxos_user_module.html
