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

Новая в версии 2.7.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
content строка			Содержание скрипта. Этот параметр обычно используется совместно с `file`, или плагинами поиска шаблонов Ansible. Если это звучит для вас непривычно, см. примеры в этом документе.
description строка			Описание скрипта командной строки.
name строка / обязательно			Указывает имя скрипта.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
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 строка	Варианты: cli 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 конфигураций на диске, убедитесь, что включён хотя бы один этап, использующий модуль 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 is bar

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается партнером Ansible. [certified]

Авторы

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