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

access_mode

string

Определяет, разрешает ли конфигурация сеанса подключение только с компьютера local, с локального компьютера и remote либо не разрешает подключения (disabled).

Варианты:

• "disabled"
• "local"
• "remote"

alias_definitions

dictionary

Словарь, определяющий псевдонимы для каждого сеанса.

assemblies_to_load

list / elements=string

Сборки, которые необходимо загрузить в каждый сеанс.

async_poll

integer

Задает задержку в секундах между проверками состояния асинхронного выполнения.

Повторяет функциональность ключевого слова poll.

Не действует в режиме проверки.

async_poll=0 не поддерживается.

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

async_timeout

integer

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

Повторяет функциональность ключевого слова async.

Не действует в режиме проверки.

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

author

string

Автор конфигурации сеанса.

Это значение является метаданными и не влияет на работу конфигурации сеанса.

Если значение не задано, оно может быть сгенерировано автоматически.

См. также lenient_config_fields.

company_name

string

Компания, создавшая конфигурацию сеанса.

Это значение является метаданными и не влияет на работу конфигурации сеанса.

Если значение не задано, оно может быть сгенерировано автоматически.

См. также lenient_config_fields.

copyright

string

Уведомление об авторских правах для конфигурации сеанса.

Это значение является метаданными и не влияет на работу конфигурации сеанса.

Если значение не задано, оно может быть сгенерировано автоматически.

См. также lenient_config_fields.

description

string

Описание конфигурации сеанса.

Это значение является метаданными и не влияет на работу конфигурации сеанса.

См. также lenient_config_fields.

environment_variables

dictionary

Словарь, определяющий переменные среды для каждого сеанса.

execution_policy

string

Политика выполнения, регулирующая запуск сценариев в сеансе PowerShell.

Варианты:

• "default"
• "remote_signed"
• "restricted"
• "undefined"
• "unrestricted"

formats_to_process

list / elements=path

Пути к файлам определений форматов для обработки в каждом сеансе.

function_definitions

dictionary

Словарь, определяющий функции для каждого сеанса.

group_managed_service_account

string

Если сеанс будет выполняться от имени групповой управляемой служебной учетной записи (gMSA), укажите здесь ее имя.

Не используйте run_as_credential_username и run_as_credential_password для указания gMSA.

guid

any

GUID (UUID) файла конфигурации сеанса.

Это значение является метаданными и имеет значение только при внешнем использовании.

Если значение не задано, оно будет сгенерировано автоматически.

Форматы GUID допускают гибкую запись. Будет принята любая строка из 32 шестнадцатеричных цифр; все дефисы - и открывающие/закрывающие {} игнорируются.

См. также lenient_config_fields.

language_mode

string

Определяет языковой режим сеанса PowerShell.

Варианты:

• "no_language"
• "restricted_language"
• "constrained_language"
• "full_language"

lenient_config_fields

list / elements=string

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

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

По умолчанию: ["guid", "author", "company_name", "copyright", "description"]

maximum_received_data_size_per_command_mb

any

Задает максимальный размер получаемых данных на одну команду в МБ.

Значение должно помещаться в число с плавающей точкой двойной точности.

maximum_received_object_size_mb

any

Задает максимальный размер объекта в МБ.

Значение должно помещаться в число с плавающей точкой двойной точности.

modules_to_import

list / elements=any

Список модулей, которые необходимо импортировать в сеанс.

Здесь можно использовать любую допустимую спецификацию модуля PowerShell, поэтому можно указывать простые строковые имена или словари.

Если используется словарь, преобразование snake_case не выполняется, поэтому необходимо указывать исходные имена PowerShell.

mount_user_drive

boolean

Если yes, сеанс создает и подключает пользовательский PSDrive для передачи файлов.

Варианты:

• false
• true

name

string / обязательный

Имя конфигурации сеанса, которой необходимо управлять.

powershell_version

any

Минимальная версия PowerShell, необходимая для этого сеанса.

Должна быть указана в виде допустимой строки .Net System.Version.

processor_architecure

string

Архитектура процессора сеанса (32- или 64-разрядная).

Варианты:

• "amd64"
• "x86"

required_groups

dictionary

Для сеансов JEA определяет правила условного доступа, указывающие, в каких группах должен состоять подключающийся пользователь.

Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/session-configurations#conditional-access-rules.

role_definitions

dictionary

Словарь с определениями ролей для сеансов JEA.

Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/session-configurations#role-definitions.

run_as_credential_password

string

Пароль для run_as_credential_username.

run_as_credential_username

string

Используется для задания учетной записи RunAs для сеанса. Все команды, выполняемые в сеансе, будут запущены от имени этого пользователя.

Сведения об использовании gMSA см. в разделе group_managed_service_account.

Сведения об использовании виртуальной учетной записи см. в разделах run_as_virtual_account и run_as_virtual_account_groups.

Статус всегда будет changed, если заданы учетные данные RunAs, поскольку пароль невозможно получить для сравнения.

run_as_virtual_account

boolean

Если yes, сеанс выполняется от имени виртуальной учетной записи.

Не используйте run_as_credential_username и run_as_credential_password для указания виртуальной учетной записи.

Варианты:

• false
• true

run_as_virtual_account_groups

list / elements=string

Если run_as_virtual_account=yes, это список групп, в которые необходимо добавить виртуальную учетную запись.

schema_version

any

Версия схемы файла конфигурации сеанса.

Если значение не задано, оно будет сгенерировано автоматически.

Должна быть указана в виде допустимой строки .Net System.Version.

scripts_to_process

list / elements=string

Список путей к файлам сценариев с расширением .ps1, которые необходимо применить к сеансу.

security_descriptor_sddl

string

Строка SDDL, определяющая, каким пользователям и группам разрешено подключаться к сеансу.

Если указан параметр role_definitions, дескриптор безопасности будет задан на его основе.

Если этот параметр не указан, будет применен дескриптор безопасности по умолчанию.

session_type

string

Определяет тип сеанса.

Варианты:

• "default"
• "empty"
• "restricted_remote_server"

startup_script

path

Сценарий, запускаемый при запуске сеанса.

state

string

Желаемое состояние конфигурации.

Варианты:

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

thread_apartment_state

string

Состояние апартаментов потока для сеанса PowerShell.

Варианты:

• "mta"
• "sta"

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

Если yes, сеансы используют общий процесс.

Варианты:

• false
• true

user_drive_maximum_size

any

Максимальный размер пользовательского диска в байтах.

Значение должно помещаться в Int64.

variable_definitions

list / elements=dictionary

Список словарей, каждый элемент которого определяет переменную для каждого сеанса.

visible_aliases

list / elements=string

Псевдонимы, которые можно использовать в сеансе.

Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/role-capabilities.

visible_cmdlets

list / elements=any

Командлеты, которые можно использовать в сеансе.

Элементы могут быть простыми именами или сложными спецификациями команд.

Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/role-capabilities.

visible_external_commands

list / elements=string

Внешние команды и сценарии, которые можно использовать в сеансе.

Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/role-capabilities.

visible_functions

list / elements=any

Функции, которые можно использовать в сеансе.

Элементы могут быть простыми именами или сложными спецификациями команд.

Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/powershell/scripting/learn/remoting/jea/role-capabilities.