Модуль 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, поэтому могут использоваться простые имена str или словари.

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

mount_user_drive

boolean

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

Варианты:

• false
• true

name

string / required

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

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" ← (default)
• "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/ru-ru/powershell/scripting/learn/remoting/jea/role-capabilities.

visible_cmdlets

list / elements=any

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

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

Для получения дополнительной информации см. 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=any

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

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

Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/powershell/scripting/learn/remoting/jea/role-capabilities.