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

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

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
command -			Команда для присвоения псевдонима.
description -			Описание псевдонима.
name - / обязательно			Указывает имя псевдонима.
partition -		По умолчанию: "Common"	Раздел устройства для управления ресурсами. Этот параметр игнорируется, когда `scope` равен `private`.
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`.
scope -		Варианты: private shared ←	Сфера действия псевдонима; общедоступный ли он в системе или доступен только для пользователя, который его создал.
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 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

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается партнером 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_alias_module.html