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

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

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

Краткое описание

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
content -			Содержание скрипта. Этот параметр обычно используется в сочетании с `file`, или плагинами поиска шаблонов Ansible. Если это звучит для вас непонятно, обратитесь к примерам в этом руководстве.
description -			Описание скрипта командной строки.
name - / обязательно			Указывает имя скрипта.
partition -		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
provider - добавлено в 2.5		По умолчанию: null	Объект словаря с деталями подключения.
	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 -	По умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечет до завершения операции, модуль вернет ошибку.
	transport - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Используйте только на сайтах под вашим контролем, использующих самозаверяемые сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
server - / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port - добавлено в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
state -		Варианты: present ← absent	Когда `present`, гарантирует, что скрипт существует. Когда `absent`, гарантирует удаление скрипта.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs boolean добавлено в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Используйте только на сайтах под вашим контролем, использующих самозаверяемые сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия ПО 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 boolean	changed	Новое значение param1 ресурса. Пример: True
param2 string	changed	Новое значение param2 ресурса. Пример: Foo is bar

Статус

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

Авторы

Tim Rupp (@caphrim007)

Подсказка

Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_cli_script_module.html