модуль microsoft.iis.website — настраивает веб-сайт IIS

Примечание

Этот модуль входит в коллекцию microsoft.iis (версия 1.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install microsoft.iis. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: microsoft.iis.website.

Краткое описание
Требования
Параметры
Атрибуты
См. также
Примеры

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

Создаёт, удаляет и настраивает веб-сайт IIS.

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

Модуль PowerShell IISAdministration

Параметры

Параметр	Комментарии
application_pool string	Указывает пул приложений, в котором работает веб-сайт. Пул приложений должен существовать заранее, иначе веб-сайт не запустится.
bindings dictionary	Указывает привязки веб-сайта, которые нужно добавить, удалить или задать. Комбинация `ip:port:hostname` является уникальным идентификатором привязки. Привязка `ip:port` должна быть доступна и не использоваться другими веб-сайтами на сервере. Чтобы удалить все привязки веб-сайта, используйте `bindings.set` с пустым списком. По умолчанию: `{}`
add list / elements=dictionary	Указывает список привязок для добавления к веб-сайту.
certificate_hash string	Хэш сертификата (отпечаток) для привязки SSL. Хэш сертификата является его уникальным идентификатором. Указать отпечаток сертификата можно только при условии `bindings.add.protocol=https`. При использовании хранилища центральных сертификатов сертификат автоматически извлекается из хранилища, а не назначается привязке вручную.
certificate_store_name string	Имя хранилища сертификатов, в котором находится сертификат для привязки. По умолчанию: `"my"`
hostname string	Имя узла (DNS) для привязки веб-сайта. Обязателен, если `bindings.add.use_sni=true` или `bindings.add.use_ccs=true`.
ip string	IP-адрес для прослушивания привязкой веб-сайта.
port integer	Порт для прослушивания привязкой веб-сайта.
protocol string	Протокол веб-сайта (http, https). Варианты: `"http"` ← (по умолчанию) `"https"`
use_ccs boolean	Использовать централизованное хранилище сертификатов (CCS) для сертификатов SSL. Можно использовать только при условии `bindings.add.protocol=https`. Если `bindings.add.use_ccs=true`, необходимо задать значение `bindings.add.hostname`. Если `true`, не следует использовать `bindings.add.certificate_hash`. Варианты: `false` `true`
use_sni boolean	Требовать указание имени сервера (SNI) для сертификатов SSL. Можно использовать только при протоколе https. Если `bindings.add.use_sni=true`, необходимо задать значение `bindings.add.hostname`. Варианты: `false` `true`
remove list / elements=dictionary	Указывает список привязок для удаления с веб-сайта.
hostname string	Имя узла (DNS) для привязки веб-сайта.
ip string	IP-адрес для прослушивания привязкой веб-сайта.
port integer	Порт для прослушивания привязкой веб-сайта.
set list / elements=dictionary	Указывает точный список привязок, которые нужно задать для веб-сайта. Все существующие привязки, отсутствующие в указанном списке, будут удалены. Все привязки из указанного списка, которых ещё нет у веб-сайта, будут добавлены. Чтобы удалить все привязки веб-сайта, задайте пустой список.
certificate_hash string	Хэш сертификата (отпечаток) для привязки SSL. Хэш сертификата является его уникальным идентификатором. Указать отпечаток сертификата можно только при условии `bindings.set.protocol=https`. При использовании хранилища центральных сертификатов сертификат автоматически извлекается из хранилища, а не назначается привязке вручную.
certificate_store_name string	Имя хранилища сертификатов, в котором находится сертификат для привязки. При использовании хранилища центральных сертификатов сертификат автоматически извлекается из хранилища, а не назначается вручную. По умолчанию: `"my"`
hostname string	Имя узла (DNS) для привязки веб-сайта. Обязателен, если `bindings.set.use_sni=true` или `bindings.set.use_ccs=true`.
ip string	IP-адрес для прослушивания привязкой веб-сайта.
port integer	Порт для прослушивания привязкой веб-сайта.
protocol string	Протокол веб-сайта (http, https). Варианты: `"http"` ← (по умолчанию) `"https"`
use_ccs boolean	Использовать централизованное хранилище сертификатов (CCS) для сертификатов SSL. Можно использовать только при условии `bindings.set.protocol=https`. Если `bindings.set.use_ccs=true`, необходимо задать значение `bindings.set.hostname`. Если `true`, не следует использовать `bindings.set.certificate_hash`. Варианты: `false` `true`
use_sni boolean	Требовать указание имени сервера (SNI) для сертификатов SSL. Можно использовать только при условии `bindings.set.protocol=https`. Если `bindings.set.use_sni=true`, необходимо задать значение `bindings.set.hostname`. Варианты: `false` `true`
name string / обязательный	Имя веб-сайта, которым нужно управлять.
physical_path string	Указывает путь к физической папке на удалённом узле, которую нужно использовать для веб-сайта. При создании веб-сайта необходимо указать physical_path. Указанная папка должна существовать.
site_id string	Явно задаёт числовой идентификатор веб-сайта IIS. Обратите внимание: это значение нельзя изменить после создания веб-сайта. Идентификатор сайта должен быть доступен и не использоваться другими веб-сайтами на сервере.
state string	Состояние веб-сайта. Для запуска веб-сайта необходимо настроить хотя бы одну привязку. Варианты: `"absent"` `"started"` ← (по умолчанию) `"stopped"` `"restarted"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме check_mode и возвращать прогноз изменения состояния без внесения изменений в целевую систему; если режим не поддерживается, действие будет пропущено.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в режиме check_mode).
platform	Платформа: windows	Целевые ОС и семейства ОС, с которыми можно работать.

См. также

microsoft.iis.website_info: Получение сведений о веб-сайтах IIS.
microsoft.iis.web_app_pool: Настройка пулов веб-приложений IIS.

Примеры

- name: Create a default website in 'Started' state
  microsoft.iis.website:
    name: WebSite
    physical_path: C:\inetpub\wwwroot
    state: started
    bindings:
      set:
        - ip: 127.0.0.1
          port: 80
          hostname: my-website.com

- name: Create a website with two bindings, set all values and start it
  microsoft.iis.website:
    name: WebSite
    site_id: 2
    state: started
    physical_path: C:\wwwroot\websites\my-website
    application_pool: DefaultAppPool
    bindings:
      set:
        - ip: 127.0.0.1
          port: 8081
          hostname: my-website.com
        - ip: 127.0.0.2
          port: 8082
          hostname: my-website.net
          protocol: https
          use_sni: true
          use_ccs: false
          certificate_hash: 5409124040FA1C8FA74939BDA2EF8FD5975BD25B
          certificate_store_name: MY

- name: Remove all the bindings from an existing website
  microsoft.iis.website:
    name: WebSite
    bindings:
      set: []

- name: Remove a specific binding from an existing website
  microsoft.iis.website:
    name: WebSite
    bindings:
      remove:
        - ip: 127.0.0.1
          port: 8081
          hostname: my-website.com

- name: Add bindings to an existing website
  microsoft.iis.website:
    name: WebSite
    bindings:
      add:
        - ip: 127.0.0.3
          port: 8083
          hostname: new-website.com
        - ip: 127.0.0.4
          port: 8084
          hostname: new-website.net

- name: Stop a website
  microsoft.iis.website:
    name: WebSite
    state: stopped

- name: Restart a website (non-idempotent)
  microsoft.iis.website:
    name: WebSite
    state: restarted

- name: Change a website application pool
  microsoft.iis.website:
    name: WebSite
    application_pool: NewAppPool

- name: Change a website physical path
  microsoft.iis.website:
    name: WebSite
    physical_path: C:\wwwroot\websites\my-website

Авторы

Shahar Golshani (@sgolshan)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/microsoft/iis/website_module.html