Модуль f5networks.f5_modules.bigip_cli_alias — Управление псевдонимами командной строки на BIG-IP

Примечание

Этот модуль входит в состав коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в книге задач, укажите: f5networks.f5_modules.bigip_cli_alias.

Впервые появился в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Позволяет управлять частными и общими псевдонимами на BIG-IP.

Параметры

Параметр	Комментарии
command строка	Команда для присвоения псевдонима.
description строка	Описание псевдонима.
name строка / обязательно	Указывает имя псевдонима.
partition строка	Раздел устройства, в котором нужно управлять ресурсами. Этот параметр игнорируется, когда `scope` равно `private`. Значение по умолчанию: `"Common"`
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem булево	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела из-за неоднозначного названия. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль для учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, задав переменную среды `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или BIG-IQ. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER_PORT`. Значение по умолчанию: `443`
timeout целое число	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное подключение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, задав переменную среды `F5_USER`.
validate_certs булево	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
scope строка	Область действия псевдонима; является ли он общим для системы или доступным только пользователю, который его создал. Варианты: `"private"` `"shared"` ← (по умолчанию)
state строка	Если `present`, гарантирует существование ресурса. Если `absent`, гарантирует удаление ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы гарантировать сохранение специфичной для BIG-IP конфигурации на диске, убедитесь, что вы включили хотя бы одну задачу, использующую модуль f5networks.f5_modules.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 строка	Новая команда, к которой присвоено псевдоним. Возвращено: изменённо Пример: `"run /util bash"`
description строка	Новое описание псевдонима. Возвращено: изменённо Пример: `"Run the bash shell"`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_cli_alias_module.html