Spec-Zone.ru › Ansible 2.7

bigip_ucs – Управление загрузкой, установкой и удалением файлов UCS

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

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

Обзор

  • Управление загрузкой, установкой и удалением файлов UCS.

Требования

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

  • f5-sdk >= 3.0.16

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
force
boolean
    Варианты:
  • нет ←
  • да
Если yes, файл будет загружаться каждый раз и заменять файл на устройстве. Если no, файл будет загружен только в том случае, если он еще не существует. В общем случае, должно быть yes только в случаях, когда есть основания полагать, что изображение было повреждено во время загрузки.
include_chassis_level_config
boolean
    Варианты:
  • нет
  • да
Во время восстановления файла UCS включать конфигурацию уровня шасси, которая используется совместно наборами загрузочных томов. Например, конфигурация по умолчанию кластера.
no_license
boolean
    Варианты:
  • нет
  • да
Выполняет полное восстановление файла UCS и всех содержащихся в нём файлов, за исключением файла лицензии. Этот параметр необходимо использовать для восстановления UCS на устройствах RMA (Returned Materials Authorization).
no_platform_check
boolean
    Варианты:
  • нет
  • да
Пропускает проверку платформы и позволяет установить файл UCS, созданный с использованием другой платформы. По умолчанию (без этого параметра) установка UCS, созданного с другой платформы, запрещена.
passphrase
boolean
    Варианты:
  • нет
  • да
Указывает пароль, необходимый для загрузки указанного файла UCS.
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, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяемыми сертификатами.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.
reset_trust
boolean
    Варианты:
  • нет
  • да
При указании этого параметра, сертификаты и ключи устройства и домена доверия не загружаются из файла UCS. Вместо этого создаётся новый набор.
server
- / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER.
server_port
-
добавлен в 2.2
По умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT.
state
-
    Варианты:
  • отсутствует
  • установлен
  • наличие ←
Когда installed, гарантирует, что файл UCS загружен и установлен на системе. Когда present, гарантирует, что файл UCS загружен. Когда absent, файл UCS будет удален с системы. Когда installed, загрузка файла UCS идемпотентна, но установка этой конфигурации неидемпотентна.
ucs
-
Путь к файлу UCS для установки. Параметр должен быть указан, если state равно installed или activated. Когда state равно absent, полный путь к этому параметру будет проигнорирован, и для выбора файла UCS для удаления будет использовано только имя файла. Таким образом, вы можете указать /mickey/mouse/test.ucs, и этот модуль будет искать только test.ucs.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную окружения F5_USER.
validate_certs
boolean
добавлен в 2.0
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяемыми сертификатами.
Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.

Примечания

Примечание

  • Этот модуль выполняет только самые базовые проверки. Необходимо учитывать другие проверки и соображения. См. следующий URL-адрес. https://support.f5.com/kb/en-us/solutions/public/11000/300/sol11318.html
  • Этот модуль не обрабатывает устройства с FIPS 140 HSM
  • Этот модуль не обрабатывает системы BIG-IP на аппаратной платформе 6400, 6800, 8400 или 8800.
  • Этот модуль не проверяет, что новые или заменённые ключи SSH из файла UCS синхронизированы между системой BIG-IP и SCCP
  • Этот модуль не поддерживает опцию «rma»
  • Этот модуль не поддерживает восстановление архива UCS на системе BIG-IP 1500, 3400, 4100, 6400, 6800 или 8400, кроме системы, с которой был создан резервный архив
  • Операция восстановления UCS восстанавливает полную конфигурацию только в том случае, если имя хоста целевой системы совпадает с именем хоста, на котором был создан архив UCS. Если имя хоста не совпадает, восстанавливается только общая конфигурация. Вы можете убедиться в соответствии имён хостов, используя модуль bigip_hostname Ansible в задаче перед использованием этого модуля.
  • Этот модуль не поддерживает повторную лицензирование BIG-IP, восстановленного из UCS
  • Этот модуль не поддерживает восстановление зашифрованных архивов на замещающих устройствах RMA.
  • Дополнительную информацию об использовании 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: Upload UCS
  bigip_ucs:
    server: lb.mydomain.com
    user: admin
    password: secret
    ucs: /root/bigip.localhost.localdomain.ucs
    state: present
  delegate_to: localhost

- name: Install (upload, install) UCS.
  bigip_ucs:
    server: lb.mydomain.com
    user: admin
    password: secret
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
  delegate_to: localhost

- name: Install (upload, install) UCS without installing the license portion
  bigip_ucs:
    server: lb.mydomain.com
    user: admin
    password: secret
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    no_license: yes
  delegate_to: localhost

- name: Install (upload, install) UCS except the license, and bypassing the platform check
  bigip_ucs:
    server: lb.mydomain.com
    user: admin
    password: secret
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    no_license: yes
    no_platform_check: yes
  delegate_to: localhost

- name: Install (upload, install) UCS using a passphrase necessary to load the UCS
  bigip_ucs:
    server: lb.mydomain.com
    user: admin
    password: secret
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    passphrase: MyPassphrase1234
  delegate_to: localhost

- name: Remove uploaded UCS file
  bigip_ucs:
    server: lb.mydomain.com
    user: admin
    password: secret
    ucs: bigip.localhost.localdomain.ucs
    state: absent
  delegate_to: localhost

Статус

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API