ansible.windows.win_package модуль — Установка/удаление устанавливаемого пакета

arguments

any

Любые аргументы, необходимые установщику для установки или удаления пакета.

Если пакет является MSI, не указывайте аргументы /qn, /log или /norestart.

Это используется только для поставщиков msi, msp и registry.

Может быть списком аргументов, и модуль будет экранировать аргументы по мере необходимости; рекомендуется использовать строку при работе с пакетами MSI из-за уникальных проблем с экранированием в msiexec.

При использовании списка аргументов каждый элемент списка считается одним аргументом. Таким образом, если аргумент в списке содержит пробел, Ansible заключит его в кавычки, чтобы убедиться, что Windows воспринимает его как один аргумент. Если это поведение не требуется, аргумент следует разделить на два отдельных элемента списка. Более подробную информацию см. в разделе «Примеры».

chdir

path

Устанавливает указанный путь в качестве текущего рабочего каталога перед установкой или удалением пакета.

Это используется только для поставщиков msi, msp и registry.

client_cert

string

Путь к клиентскому сертификату (.pfx), используемому для проверки подлинности X509. Этот путь может быть либо путем к pfx в файловой системе, либо путем к сертификату PowerShell Cert:\CurrentUser\My\<thumbprint>.

Подключение WinRM должно быть аутентифицировано с помощью CredSSP или become, если файл сертификата не защищен паролем.

Другие типы аутентификации могут устанавливать client_cert_password, если сертификат защищен паролем.

client_cert_password

string

Пароль для client_cert, если сертификат защищен паролем.

creates_path

path

Проверит существование указанного пути и использует результат для определения того, установлен ли пакет.

Вы можете использовать это в сочетании с product_id и другими creates_*.

creates_service

string

Проверит существование указанной службы и использует результат для определения того, установлен ли пакет.

Вы можете использовать это в сочетании с product_id и другими creates_*.

creates_version

string

Проверит свойство версии файла в creates_path и использует результат для определения того, установлен ли пакет.

creates_path ДОЛЖЕН быть установлен и является файлом.

Вы можете использовать это в сочетании с product_id и другими creates_*.

expected_return_code

list / elements=integer

Один или несколько кодов возврата от установки пакета, указывающих на успех.

Коды возврата читаются как знаковое целое число; любые значения, большие чем 2147483647, должны быть представлены как знакомый эквивалент, например, 4294967295 — это -1.

Чтобы преобразовать беззнаковое число в знаковый эквивалент, можно выполнить «[Int32]("0x{0:X}" -f ([UInt32]3221225477))».

Код возврата 3010 обычно означает, что требуется перезагрузка; значение возврата reboot_required устанавливается, если код возврата равен 3010.

Это используется только для поставщиков msi, msp и registry.

Значение по умолчанию: [0, 3010]

follow_redirects

string

Следует ли модулю перенаправлять запросы.

all будет следовать всем перенаправлениям.

none не будет следовать ни одному перенаправлению.

safe будет следовать только «безопасным» перенаправлениям, где «безопасный» означает, что клиент выполняет только GET или HEAD по URI, на который он перенаправляется.

При перенаправлении по перенаправленному URL-адресу заголовок Authorization и любые установленные учетные данные будут отброшены и не перенаправлены.

Варианты:

• "all"
• "none"
• "safe" ← (по умолчанию)

force_basic_auth

boolean

По умолчанию заголовок аутентификации отправляется только тогда, когда веб-сервис отвечает на первоначальный запрос со статусом 401. Поскольку некоторые службы Basic Auth не отправляют 401 должным образом, вход будет невозможен.

Этот параметр принудительно отправляет заголовок Basic Authentication при первоначальном запросе.

Варианты:

• false ← (по умолчанию)
• true

headers

dictionary

Дополнительные заголовки для установки в запросе.

Это должен быть словарь, где ключ — имя заголовка, а значение — значение для этого заголовка.

http_agent

string

Заголовок для идентификации, обычно отображается в логах веб-сервера.

Это устанавливается в заголовок User-Agent в HTTP-запросе.

Значение по умолчанию: "ansible-httpget"

log_path

path

Указывает путь к файлу журнала, который сохраняется после установки или удаления пакета.

Это используется только для поставщика msi или msp.

Если этот параметр опущен, вместо этого используется временный файл журнала для этих поставщиков.

Это допустимо только для файлов MSI; используйте arguments для поставщика registry.

maximum_redirection

integer

Указывает, сколько раз модуль перенаправит подключение к альтернативному URI, прежде чем подключение завершится неудачей.

Если установлено значение 0 или follow_redirects установлен в none, или safe при отсутствии GET или HEAD, это предотвращает все перенаправления.

Значение по умолчанию: 50

path

string

Расположение пакета для установки или удаления.

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

Когда state=present, product_id не задан, а путь является URL-адресом, этот файл всегда будет загружен во временную директорию для проверки идемпотентности, в противном случае файл будет загружен только в том случае, если пакет не был установлен на основе проверок product_id.

Если state=present, то это значение ДОЛЖНО быть задано.

Если state=absent, то это значение не нужно задавать, если задано product_id.

product_id

string

Идентификатор продукта установленного пакета.

Используется для проверки того, установлен ли продукт, и получения информации об удалении, если state=absent.

Для пакетов MSI это ProductCode (GUID) пакета. Его можно найти по тем же реестровым путям, что и у поставщика registry.

Для пакетов MSP это PatchCode (GUID) пакета, который можно найти в свойствах файла по Details -> Revision number.

Для пакетов msix это Name или PackageFullName пакета, найденные с помощью командлета Get-AppxPackage.

Для пакетов реестра (exe) это имя ключа реестра по указанным в provider реестровым путям.

Это значение игнорируется, если path задан в виде локального пути к файлу, и пакет не является exe.

Это значение ДОЛЖНО быть задано, когда пакет является exe, или путь является URL-адресом или сетевым ресурсом, и делегирование учетных данных не используется. Вместо этого можно использовать параметры creates_*, но это не рекомендуется.

provider

string

Устанавливает поставщика пакетов для поиска пакета.

Поставщик auto выберет соответствующего поставщика, если path, иначе он отсканирует все остальные поставщики на основе product_id.

Поставщик msi сканирует пакеты MSI, установленные в глобальном контексте системы и текущем контексте пользователя на основе ProductCode MSI.

Поставщик msix используется для установки пакетов .appx, .msix, .appxbundle, или .msixbundle. Эти пакеты устанавливаются или удаляются только в контексте текущего пользователя. Хост должен быть настроен для поддержки загружаемых приложений или в режиме разработчика. Примеры настройки приведены в примерах использования. Если пакет уже установлен, но path указывает на обновленный пакет, то он будет установлен поверх существующего.

Поставщик msp сканирует все исправления MSP, установленные в глобальном контексте системы и текущем контексте пользователя на основе PatchCode MSP. Исправление msp будет применено или удалено ко всем соответствующим msi продуктам, к которым оно относится, и установлено. Если исправление устарело или заменено, никаких действий не будет предпринято.

Поставщик registry используется для традиционных установщиков exe и использует следующие реестровые пути для определения, был ли продукт установлен; HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall, HKLM:\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall, HKCU:\Software\Microsoft\Windows\CurrentVersion\Uninstall, и HKCU:\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall.

Варианты:

• "auto" ← (по умолчанию)
• "msi"
• "msix"
• "msp"
• "registry"

proxy_password

string

Пароль для proxy_username.

proxy_url

string

Явный прокси для использования в запросе.

По умолчанию запрос использует прокси, определенный в IE, если use_proxy не задано как no.

proxy_use_default_credential

boolean

Использует учетные данные текущего пользователя при аутентификации с прокси-хостом, защищенным аутентификацией NTLM, Kerberos, или Negotiate.

Прокси, использующие аутентификацию Basic, все равно потребуют явных учетных данных через параметры proxy_username и proxy_password.

Модуль получит доступ к учетным данным пользователя только при использовании become с паролем, соединении с SSH с паролем или соединении с WinRM с использованием CredSSP или Kerberos with delegation.

Если не используется become или другой метод аутентификации, указанный выше, доступные учетные данные по умолчанию будут отсутствовать, и аутентификация по прокси не произойдет.

Варианты:

• false ← (по умолчанию)
• true

proxy_username

string

Имя пользователя для аутентификации по прокси.

state

string

Указывает на установку или удаление пакета.

Модуль использует product_id для определения того, установлен ли пакет.

Для всех поставщиков, кроме auto, path можно использовать для проверки идемпотентности, если это локальный путь к файловому диску.

Варианты:

• "absent"
• "present" ← (по умолчанию)

url_method

string

Метод HTTP запроса.

url_password

string

Пароль для url_username.

url_timeout

integer

Устанавливает время ожидания запроса перед его истечением (в секундах).

Установленное значение 0 указывает на бесконечное время ожидания.

По умолчанию: 30

url_username

string

Имя пользователя для аутентификации.

use_default_credential

boolean

Использует учетные данные текущего пользователя при аутентификации с сервером, защищенным аутентификацией NTLM, Kerberos, или Negotiate.

Серверы, использующие аутентификацию Basic, все равно потребуют явных учетных данных через параметры url_username и url_password.

Модуль получит доступ к учетным данным пользователя только при использовании become с паролем, соединении с SSH с паролем или соединении с WinRM с использованием CredSSP или Kerberos with delegation.

Если не используется become или другой метод аутентификации, указанный выше, доступные учетные данные по умолчанию будут отсутствовать, и аутентификация не произойдёт.

Варианты:

• false ← (по умолчанию)
• true

use_proxy

boolean

Если no, прокси, определённый в IE для текущего пользователя, не будет использоваться.

Варианты:

• false
• true ← (по умолчанию)

validate_certs

boolean

Если no, сертификаты SSL не будут проверены.

Использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.

Варианты:

• false
• true ← (по умолчанию)

wait_for_children

boolean

добавлен в ansible.windows 1.3.0

Модуль будет ждать завершения процесса, который он запустил, но любые процессы, запущенные в этом дочернем процессе, будут проигнорированы.

Установите true для ожидания завершения всех дочерних процессов перед возвращением модуля.

Это полезно, если установщик/деинсталлятор является просто оболочкой, которая затем вызывает фактический установщик в качестве собственного дочернего процесса. Когда этот параметр true, модуль будет ожидать завершения обоих процессов перед возвратом.

Этого обычно не требуется для большинства установщиков, и установка на true может привести к тому, что модуль не вернётся до тех пор, пока процесс, ожидающий его, не будет остановлен вручную.

Требуется Windows Server 2012 или Windows 8 или более поздняя версия.

Варианты:

• false ← (по умолчанию)
• true