bigip_cli_alias – Управление псевдонимами командной строки на BIG-IP
Новое в версии 2.7.
Описание
- Позволяет управлять как частными, так и общими псевдонимами на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| command строка | Команда для присвоения псевдонима. | ||
| description строка | Описание псевдонима. | ||
| name строка / обязательно | Указывает имя псевдонима. | ||
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. Этот параметр игнорируется, когда scope равно private. | |
| provider словарь добавлено в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| password строка / обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспортов cli. Этот параметр можно опустить, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, с самозаверяющими сертификатами.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| scope строка |
| Область действия псевдонима; используется ли он на всей системе или только для пользователя, который его создал. | |
| state строка |
| Когда present, гарантирует, что ресурс существует.Когда absent, гарантирует удаление ресурса. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 только изменяют рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, обязательно включите по крайней мере одну задачу, которая использует модуль bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля, чтобы сохранить рабочую конфигурацию.
Примеры
- name: Create a new alias
bigip_cli_alias:
name: sync_device_to_bside
scope: shared
command: save /sys config partitions all; run /cm config-sync to-group device-group-1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращенное значение | Описание |
|---|---|---|
| command строка | changed | Новая команда, которой присвоен псевдоним. Пример: run /util bash |
| description строка | changed | Новое описание псевдонима. Пример: Запуск оболочки bash |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [предварительный просмотр]
- Этот модуль поддерживается партнером Ansible. [сертифицированный]
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_cli_alias_module.html
