New-PSRoleCapabilityFile

Sintaxis

Default (valor predeterminado)

New-PSRoleCapabilityFile
    [-Path] <String>
    [-Guid <Guid>]
    [-Author <String>]
    [-Description <String>]
    [-CompanyName <String>]
    [-Copyright <String>]
    [-ModulesToImport <Object[]>]
    [-VisibleAliases <String[]>]
    [-VisibleCmdlets <Object[]>]
    [-VisibleFunctions <Object[]>]
    [-VisibleExternalCommands <String[]>]
    [-VisibleProviders <String[]>]
    [-ScriptsToProcess <String[]>]
    [-AliasDefinitions <IDictionary[]>]
    [-FunctionDefinitions <IDictionary[]>]
    [-VariableDefinitions <Object>]
    [-EnvironmentVariables <IDictionary>]
    [-TypesToProcess <String[]>]
    [-FormatsToProcess <String[]>]
    [-AssembliesToLoad <String[]>]
    [<CommonParameters>]

Description

Ejemplos

Ejemplo 1: Creación de un archivo de funcionalidad de rol en blanco

New-PSRoleCapabilityFile -Path ".\ExampleFile.psrc"

Ejemplo 2: Creación de un archivo de funcionalidad de rol que permite a los usuarios reiniciar servicios y cualquier equipo VDI

$roleParameters = @{
    Path = ".\Maintenance.psrc"
    Author = "User01"
    CompanyName = "Fabrikam Corporation"
    Description = "This role enables users to restart any service and restart any VDI computer."
    ModulesToImport = "Microsoft.PowerShell.Core"
    VisibleCmdlets = "Restart-Service", @{
                      Name = "Restart-Computer"
                      Parameters = @{ Name = "ComputerName"; ValidatePattern = "VDI\d+" }
    }
}
New-PSRoleCapabilityFile @roleParameters

Parámetros

-AliasDefinitions

Agrega los alias especificados a las sesiones que usan el archivo de funcionalidad de rol. Escriba una tabla hash con las claves siguientes:

• Nombre. Nombre del alias. Esta clave es necesaria.
• Valor. Comando que representa el alias. Esta clave es necesaria.
• Descripción. Cadena de texto que describe el alias. Esta clave es opcional.
• Opciones. Opciones de alias. Esta clave es opcional. El valor predeterminado es Ninguno. Los valores aceptables para este parámetro son: None, ReadOnly, Constant, Private o AllScope.

Por ejemplo: @{Name="hlp";Value="Get-Help";Description="Gets help";Options="ReadOnly"}

Propiedades de parámetro

Conjuntos de parámetros

-AssembliesToLoad

Especifica los ensamblados que se van a cargar en las sesiones que usan el archivo de funcionalidad de rol.

Propiedades de parámetro

Conjuntos de parámetros

-Author

Especifica el usuario que creó el archivo de funcionalidad de rol.

Propiedades de parámetro

Conjuntos de parámetros

-CompanyName

Identifica la empresa que creó el archivo de funcionalidad de rol. El valor predeterminado es Desconocido.

Propiedades de parámetro

Conjuntos de parámetros

-Copyright

Especifica un copyright para el archivo de funcionalidad de rol. Si omite este parámetro, New-PSRoleCapabilityFile genera una declaración de derechos de autor mediante el valor del parámetro Author .

Propiedades de parámetro

Conjuntos de parámetros

-Description

Especifica una descripción para el archivo de funcionalidad de rol.

Propiedades de parámetro

Conjuntos de parámetros

-EnvironmentVariables

Especifica las variables de entorno para las sesiones que exponen este archivo de funcionalidad de rol. Escriba una tabla hash en la que las claves son los nombres de las variables de entorno y los valores son los valores de las variables de entorno.

Por ejemplo: EnvironmentVariables=@{TestShare="\\\\Server01\TestShare"}

Propiedades de parámetro

Conjuntos de parámetros

-FormatsToProcess

Especifica los archivos de formato (.ps1xml) que se ejecutan en las sesiones que utilizan el archivo de funcionalidad de rol. El valor de este parámetro debe ser una ruta de acceso completa o absoluta de los archivos de formato.

Propiedades de parámetro

Conjuntos de parámetros

-FunctionDefinitions

Agrega las funciones especificadas a las sesiones que exponen la funcionalidad de rol. Escriba una tabla hash con las claves siguientes:

• Nombre. Nombre de la función. Esta clave es necesaria.
• Bloque de script. Cuerpo de la función. Escriba un bloque de script. Esta clave es necesaria.
• Opciones. Opciones de función. Esta clave es opcional. El valor predeterminado es Ninguno. Los valores aceptables para este parámetro son: none, ReadOnly, Constant, Private o AllScope.

Por ejemplo:

@{Name="Get-PowerShellProcess";ScriptBlock={Get-Process PowerShell};Options="AllScope"}

Propiedades de parámetro

Conjuntos de parámetros

-Guid

Especifica un identificador único para el archivo de funcionalidad de rol. Si omite este parámetro, New-PSRoleCapabilityFile genera un GUID para el archivo. Para crear un nuevo GUID en PowerShell, escriba [guid]::NewGuid().

Propiedades de parámetro

Conjuntos de parámetros

-ModulesToImport

Especifica los módulos que se importan automáticamente en sesiones que usan el archivo de funcionalidad de rol. De forma predeterminada, todos los comandos de los módulos enumerados están visibles. Cuando se usa con VisibleCmdlets o VisibleFunctions, se pueden restringir los comandos visibles desde los módulos especificados.

Cada módulo usado en el valor de este parámetro se puede representar mediante una cadena o mediante una tabla hash. Una cadena de módulo solo consta del nombre del módulo. Una tabla hash de módulo puede incluir ModuleName , ModuleVersiony claves GUID de. Solo se requiere la clave ModuleName.

Por ejemplo, el siguiente valor consta de una cadena y una tabla hash. Cualquier combinación de cadenas y tablas hash, en cualquier orden, es válida.

"TroubleshootingPack", @{ModuleName="PSDiagnostics"; ModuleVersion="1.0.0.0";GUID="c61d6278-02a3-4618-ae37-a524d40a7f44"}

Propiedades de parámetro

Conjuntos de parámetros

-Path

Especifica la ruta de acceso y el nombre de archivo del archivo de funcionalidad de rol. El archivo debe tener una extensión .psrc nombre de archivo.

Propiedades de parámetro

Conjuntos de parámetros

-ScriptsToProcess

Especifica los scripts que se van a agregar a las sesiones que usan el archivo de funcionalidad de rol. Escriba la ruta de acceso y los nombres de archivo de los scripts. El valor de este parámetro debe ser una ruta de acceso completa o absoluta de los nombres de archivo de script.

Propiedades de parámetro

Conjuntos de parámetros

-TypesToProcess

Especifica los archivos de tipo (.ps1xml) que se van a agregar a las sesiones que utilizan el archivo de funcionalidad de rol. Escriba los nombres de archivo de tipo. El valor de este parámetro debe ser una ruta de acceso completa o absoluta del tipo filenames.

Propiedades de parámetro

Conjuntos de parámetros

-VariableDefinitions

Especifica variables que se van a agregar a las sesiones que usan el archivo de funcionalidad de rol. Escriba una tabla hash con las claves siguientes:

• Nombre. nombre de la variable. Esta clave es necesaria.
• Valor. Valor de variable. Esta clave es necesaria.
• Opciones. Opciones variables. Esta clave es opcional. El valor predeterminado es Ninguno. Los valores aceptables para este parámetro son: none, ReadOnly, Constant, Private o AllScope.

Por ejemplo: @{Name="WarningPreference";Value="SilentlyContinue";Options="AllScope"}

Propiedades de parámetro

Conjuntos de parámetros

-VisibleAliases

Limita los alias de la sesión a esos alias especificados en el valor de este parámetro, además de los alias que defina en el parámetro AliasDefinition. Se admiten caracteres comodín. De forma predeterminada, todos los alias definidos por el motor de PowerShell y todos los alias que exportan los módulos están visibles en la sesión.

Por ejemplo, para limitar los alias disponibles a gm y gcm, use esta sintaxis: VisibleAliases="gcm", "gp"

Cuando se incluye cualquier parámetro visible en el archivo de funcionalidad de rol, PowerShell quita el cmdlet Import-Module y su alias de ipmo de la sesión.

Propiedades de parámetro

Conjuntos de parámetros

-VisibleCmdlets

Limita los cmdlets de la sesión a los especificados en el valor de este parámetro. Se admiten caracteres comodín y nombres calificados de módulo.

De forma predeterminada, todos los cmdlets que los módulos de la exportación de sesión están visibles en la sesión. Use los parámetros SessionType y ModulesToImport para determinar qué módulos y complementos se importan en la sesión. Si no hay módulos en ModulesToImport exponer el cmdlet, New-PSRoleCapabilityFile intenta cargar el módulo adecuado.

Cuando se incluye cualquier parámetro visible en el archivo de configuración de sesión, PowerShell quita el cmdlet Import-Module y su alias de ipmo de la sesión.

Propiedades de parámetro

Conjuntos de parámetros

-VisibleExternalCommands

Limita los archivos binarios externos, scripts y comandos que se pueden ejecutar en la sesión a los especificados en el valor de este parámetro.

De forma predeterminada, no hay ningún comando externo visible en esta sesión.

Cuando se incluye cualquier parámetro visible en el archivo de configuración de sesión, PowerShell quita el cmdlet Import-Module y su alias de ipmo de la sesión.

Propiedades de parámetro

Conjuntos de parámetros

-VisibleFunctions

Limita las funciones de la sesión a las especificadas en el valor de este parámetro, además de las funciones que defina en el parámetro FunctionDefinitions. Se admiten caracteres comodín.

De forma predeterminada, todas las funciones exportadas por módulos de la sesión están visibles en esa sesión. Use los parámetros SessionType y ModulesToImport para determinar qué módulos se importan en la sesión.

Cuando se incluye cualquier parámetro visible en el archivo de configuración de sesión, PowerShell quita el cmdlet Import-Module y su alias de ipmo de la sesión.

Propiedades de parámetro

Conjuntos de parámetros

-VisibleProviders

Limita los proveedores de PowerShell de la sesión a los especificados en el valor de este parámetro. Se admiten caracteres comodín.

De forma predeterminada, todos los proveedores exportados por un módulo de la sesión están visibles en la sesión. Use los parámetros SessionType y ModulesToImport para determinar qué módulos se importan en la sesión.

Cuando se incluye cualquier parámetro visible en el archivo de configuración de sesión, PowerShell quita el cmdlet Import-Module y su alias de ipmo de la sesión.

Propiedades de parámetro

Conjuntos de parámetros

CommonParameters

Vínculos relacionados

• New-PSSessionConfigurationFile
• Get-PSSessionCapability