community.windows.win_pssession_configuration – Управление конфигурациями PSSession

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows.

Для использования в книге задач укажите: community.windows.win_pssession_configuration.

Описание
Параметры
Примечания
См. также
Примеры

Описание

Регистрация, отмена регистрации и изменение конфигураций PSSession для удалённого PowerShell.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access_mode строка	Варианты: disabled local remote	Управляет тем, разрешает ли конфигурация сеанса подключение только с машины `local`, как локальное и `remote`, или ни того, ни другого (`disabled`).
alias_definitions словарь		Словарь, определяющий псевдонимы для каждого сеанса.
assemblies_to_load список / элементы=строка		Сборки, которые должны быть загружены в каждый сеанс.
async_poll целое число	Значение по умолчанию: 1	Устанавливает задержку в секундах между каждым проверкой состояния асинхронного выполнения. Реплицирует функциональность ключевого слова `poll`. Не оказывает влияния в режиме проверки.
async_timeout целое число	Значение по умолчанию: 300	Устанавливает таймаут в секундах для ожидания асинхронного выполнения модуля и восстановления соединения. Реплицирует функциональность ключевого слова `async`. Не оказывает влияния в режиме проверки.
author строка		Автор конфигурации сеанса. Это значение является метаданными и не влияет на функциональность конфигурации сеанса. Если не задано, значение может быть сгенерировано автоматически. См. также lenient_config_fields.
company_name строка		Компания, которая создала конфигурацию сеанса. Это значение является метаданными и не влияет на функциональность конфигурации сеанса. Если не задано, значение может быть сгенерировано автоматически. См. также lenient_config_fields.
copyright строка		Авторское право конфигурации сеанса. Это значение является метаданными и не влияет на функциональность конфигурации сеанса. Если не задано, значение может быть сгенерировано автоматически. См. также lenient_config_fields.
description строка		Описание конфигурации сеанса. Это значение является метаданными и не влияет на функциональность конфигурации сеанса. См. также lenient_config_fields.
environment_variables словарь		Словарь, определяющий переменные среды для каждого сеанса.
execution_policy строка	Варианты: default remote_signed restricted undefined unrestricted	Политика выполнения, управляющая выполнением скриптов в сеансе PowerShell.
formats_to_process список / элементы=путь		Пути к файлам определения форматов для обработки в каждом сеансе.
function_definitions словарь		Словарь, определяющий функции для каждого сеанса.
group_managed_service_account строка		Если сеанс будет выполняться как учетная запись управляемой группой службы (gMSA), то это имя. Не используйте run_as_credential_username и run_as_credential_password для указания gMSA.
guid сырое		GUID (UUID) файла конфигурации сеанса. Это значение является метаданными, поэтому оно важно только если вы его используете внешне. Если не задано, значение будет сгенерировано автоматически. Допустимые форматы GUID гибкие. Любая строка из 32 шестнадцатеричных цифр будет принята, при этом все дефисы `-` и открывающие/закрывающие `{}` игнорируются. См. также lenient_config_fields.
language_mode строка	Варианты: no_language restricted_language constrained_language full_language	Определяет режим языка сеанса PowerShell.
lenient_config_fields список / элементы=строка	Значение по умолчанию: ["guid", "author", "company_name", "copyright", "description"]	Некоторые поля, используемые в конфигурации сеанса, не влияют на его работу и иногда автоматически генерируются, если не указаны. Чтобы избежать ненужных изменений конфигурации при каждом запуске, значения этих параметров будут применяться только при их явном указании.
maximum_received_data_size_per_command_mb сырое		Устанавливает максимальный размер полученных данных на команду в МБ. Должно поместиться в значение с двойной точностью с плавающей запятой.
maximum_received_object_size_mb сырое		Устанавливает максимальный размер объекта в МБ. Должно поместиться в значение с двойной точностью с плавающей запятой.
modules_to_import список / элементы=сырое		Список модулей, которые должны быть импортированы в сеанс. Здесь можно использовать любой допустимый спецификатор модуля PowerShell, поэтому можно использовать простые имена str или словари. Если используется словарь, преобразование snake_case не выполняется, поэтому должны использоваться оригинальные имена PowerShell.
mount_user_drive булево	Варианты: no yes	Если `yes` сеанс создает и монтирует пользовательский PSDrive для использования при передаче файлов.
name строка / обязательно		Имя конфигурации сеанса для управления.
powershell_version сырое		Минимальная необходимая версия PowerShell для этого сеанса. Должно быть допустимой строкой .Net System.Version.
processor_architecure строка	Варианты: amd64 x86	Архитектура процессора сеанса (32-битная или 64-битная).
required_groups словарь		Для сеансов JEA определяет условные правила доступа, касающиеся групп, к которым должен принадлежать подключаемый пользователь. Дополнительную информацию см. на сайте https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/session-configurations#conditional-access-rules.
role_definitions словарь		Словарь, определяющий роли для сеансов JEA. Дополнительную информацию см. на сайте https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/session-configurations#role-definitions.
run_as_credential_password строка		Пароль для run_as_credential_username.
run_as_credential_username строка		Используется для установки учетной записи RunAs для сеанса. Все команды, выполняемые в сеансе, будут выполняться от имени этого пользователя. Для использования gMSA, см. group_managed_service_account. Для использования виртуальной учетной записи, см. run_as_virtual_account и run_as_virtual_account_groups. Состояние всегда будет `changed` когда установлены учетные данные RunAs, так как пароль нельзя получить для сравнения.
run_as_virtual_account булево	Варианты: no yes	Если `yes` сеанс выполняется как виртуальная учетная запись. Не используйте run_as_credential_username и run_as_credential_password для указания виртуальной учетной записи.
run_as_virtual_account_groups список / элементы=строка		Если run_as_virtual_account=yes это список групп, к которым следует добавить виртуальную учетную запись.
schema_version сырое		Версия схемы файла конфигурации сеанса. Если не задано, значение будет сгенерировано автоматически. Должно быть допустимой строкой .Net System.Version.
scripts_to_process список / элементы=строка		Список путей к файлам скриптов, заканчивающихся на `.ps1`, которые должны быть применены к сеансу.
security_descriptor_sddl строка		Строка SDDL, которая контролирует, какие пользователи и группы могут подключаться к сеансу. Если указан role_definitions, описание безопасности будет установлено на основе этого. Если этот параметр не указан, будет применено стандартное описание безопасности.
session_type строка	Варианты: default empty restricted_remote_server	Управляет типом сеанса.
startup_script путь		Скрипт, который запускается при запуске сеанса.
state строка	Варианты: present ← absent	Желаемое состояние конфигурации.
thread_apartment_state строка	Варианты: mta sta	Состояние квартиры потока для сеанса PowerShell.

thread_options string	Варианты: default reuse_thread use_current_thread use_new_thread	Устанавливает параметры потока для сеанса.
transcript_directory path		Автоматические протоколы сеанса будут записаны в этот каталог.
types_to_process list / elements=path		Пути к файлам определений типов для обработки каждого сеанса.
use_shared_process boolean	Варианты: no yes	Если `yes` , то сеанс использует общий процесс для каждого сеанса.
user_drive_maximum_size raw		Максимальный размер пользовательского диска в байтах. Должен уместиться в Int64.
variable_definitions list / elements=dictionary		Список словарей, где каждый элемент определяет переменную для каждого сеанса.
visible_aliases list / elements=string		Псевдонимы, которые могут быть использованы в сеансе. Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/powershell/scripting/learn/remoting/jea/role-capabilities.
visible_cmdlets list / elements=raw		Команды, которые могут быть использованы в сеансе. Элементы могут быть простыми именами или сложными спецификациями команд. Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/powershell/scripting/learn/remoting/jea/role-capabilities.
visible_external_commands list / elements=string		Внешние команды и скрипты, которые могут быть использованы в сеансе. Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/powershell/scripting/learn/remoting/jea/role-capabilities.
visible_functions list / elements=raw		Функции, которые могут быть использованы в сеансе. Элементы могут быть простыми именами или сложными спецификациями команд. Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/powershell/scripting/learn/remoting/jea/role-capabilities.

Примечания

Примечание

Этот модуль перезапустит службу WinRM при любом изменении. Это приведет к прерыванию всех подключений WinRM, включая те, которые используются другими запусками Ansible.
Внутренне этот модуль использует async при отсутствии режима проверки для обеспечения бесперебойной работы при перезапуске службы WinRM.
Стандартные async и poll ключевые слова использовать нельзя; вместо этого используйте параметры async_timeout и async_poll для управления асинхронным выполнением.
Установление async_poll=0 вернет результат, который может быть использован с async_status.
Параметры, для которых здесь нет значения по умолчанию, будут использовать значения по умолчанию New-PSSessionConfigurationFile и Register-PSSessionConfiguration.
Если значение можно указать как в файле конфигурации сеанса, так и напрямую в параметрах сеанса, этот модуль отдаст предпочтение настройке в файле конфигурации.

См. также

Ссылка на C(New-PSSessionConfigurationFile): Подробности и значения по умолчанию для параметров, которые попадают в файл конфигурации сеанса.
Ссылка на C(Register-PSSessionConfiguration): Подробности и значения по умолчанию для параметров, которые не указаны в файле конфигурации сеанса.
PowerShell Just Enough Administration (JEA): Обратитесь к документации JEA для расширенного использования некоторых параметров
О конфигурациях сеансов: Общая информация о конфигурациях сеансов.
О файлах конфигурации сеансов: Общая информация о файлах конфигурации сеансов.

Примеры

- name: Register a session configuration that loads modules automatically
  community.windows.win_pssession_configuration:
    name: WebAdmin
    modules_to_import:
      - WebAdministration
      - IISAdministration
    description: This endpoint has IIS modules pre-loaded

- name: Set up an admin endpoint with a restricted execution policy
  community.windows.win_pssession_configuration:
    name: GloboCorp.Admin
    company_name: Globo Corp
    description: Admin Endpoint
    execution_policy: restricted

- name: Create a complex JEA endpoint
  community.windows.win_pssession_configuration:
    name: RBAC.Endpoint
    session_type: restricted_remote_server
    run_as_virtual_account: True
    transcript_directory: '\\server\share\Transcripts'
    language_mode: no_language
    execution_policy: restricted
    role_definitions:
      'CORP\IT Support':
        RoleCapabilities:
          - PasswordResetter
          - EmployeeOffboarder
      'CORP\Webhosts':
        RoleCapabilities: IISAdmin
    visible_functions:
      - tabexpansion2
      - help
    visible_cmdlets:
      - Get-Help
      - Name: Get-Service
        Parameters:
          - Name: DependentServices
          - Name: RequiredServices
          - Name: Name
            ValidateSet:
              - WinRM
              - W3SVC
              - WAS
    visible_aliases:
      - gsv
    state: present

- name: Remove a session configuration
  community.windows.win_pssession_configuration:
    name: UnusedEndpoint
    state: absent

- name: Set a sessions configuration with tweaked async values
  community.windows.win_pssession_configuration:
    name: MySession
    description: A sample session
    async_timeout: 500
    async_poll: 5

Авторы

Brian Scholer (@briantist)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/windows/win_pssession_configuration_module.html