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

Примечание

Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

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

Новое в версии 1.0.0: of f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
command строка			Команда для создания псевдонима.
description строка			Описание псевдонима.
name строка / обязательно			Указывает имя псевдонима.
partition строка		По умолчанию: "Common"	Раздел устройства, в котором будут управляться ресурсы. Этот параметр игнорируется, когда `scope` является `private`.
provider словарь добавлен в 1.0.0 of f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое значение	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
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 строка	changed	Новая команда, к которой применен псевдоним. Пример: run /util bash
description строка	changed	Новое описание псевдонима. Пример: Запуск оболочки bash

Авторы

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

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