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

Примечание

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

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_cli_script.

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

Управляет скриптами командной строки на BIG-IP. Скрипты командной строки, также известные как скрипты tmshell или TMSH скрипты, позволяют создавать пользовательские скрипты для управления объектами на BIG-IP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
content строка			Содержимое скрипта. Этот параметр обычно используется вместе с Ansible `file` или плагинами поиска шаблонов. См. примеры в данной документации.
description строка			Описание скрипта командной строки.
name строка / обязательно			Указывает имя скрипта.
partition строка		По умолчанию: "Common"	Раздел устройства, в котором будут управляться ресурсы.
provider словарь добавлен в 1.0.0 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`.
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 cli script from an existing file
  bigip_cli_script:
    name: foo
    content: "{{ lookup('file', '/absolute/path/to/cli/script.tcl') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a cli script from a jinja template representing a cli script
  bigip_cli_script:
    name: foo
    content: "{{ lookup('template', '/absolute/path/to/cli/script.tcl') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
param1 логическое значение	changed	Новое значение параметра param1 ресурса. Пример: True
param2 строка	changed	Новое значение параметра param2 ресурса. Пример: Foo равно bar

Авторы

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_script_module.html