< Back

Add-FslAssignment

Mon Jan 13, 2020 7:52 pm

NAME Add-FslAssignment



SYNOPSIS

Adds to the content of a FSLogix Rule assignment file.





SYNTAX

Add-FslAssignment [-Path] <String> [-RuleSetApplies] -EnvironmentVariable <String> [-PassThru] [<CommonParameters>]



Add-FslAssignment [-Path] <String> [-RuleSetApplies] -OU <String> [-PassThru] [<CommonParameters>]



Add-FslAssignment [-Path] <String> [-RuleSetApplies] -ComputerName <String> [-PassThru] [<CommonParameters>]



Add-FslAssignment [-Path] <String> [-RuleSetApplies] -IPAddress <String> [-PassThru] [<CommonParameters>]



Add-FslAssignment [-Path] <String> [-RuleSetApplies] -ProcessName <String> [-IncludeChildProcess] [-PassThru]

[<CommonParameters>]



Add-FslAssignment [-Path] <String> [-RuleSetApplies] -GroupName <String> [-WellKnownSID <String>]

[-ADDistinguisedName <String>] [-PassThru] [<CommonParameters>]



Add-FslAssignment [-Path] <String> [-RuleSetApplies] -UserName <String> [-ADDistinguisedName <String>] [-PassThru]

[<CommonParameters>]



Add-FslAssignment [-Path] <String> [-PassThru] [-InputObject <Object>] [<CommonParameters>]





DESCRIPTION

This function can add to FSLogix assignment file contents, the assignment file should have the same basename as

the matching rule file.

This will not overwrite the contents of an existing file.





PARAMETERS

-Path <String>

The Target file path to set the assignment within



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-RuleSetApplies [<SwitchParameter>]

This determines whether a ruleset does or does not apply to users/groups/processes etc. For instance when

using a Hiding rule, applying that hiding rule to users will hide the file from the users assigned to it when

applied.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-UserName <String>

If you wish to tie down the rule to an individual user use theier unsername in this parameter. Groupname is

more usual for assignments however



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-GroupName <String>

Use this to tie the assignment of the rule to a specific group



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-WellKnownSID <String>

The Well Known SID for groups such as Domain Admins are useful for cross-language assignments, if you use a

group with a well known SID in the groupname parameter this will be automatically filled out, so mostly useful

for pipeline input.



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ADDistinguisedName <String>

Full Distinguished name of AD component



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ProcessName <String>

Process name for the rule assignment, mostly used for redirect rules



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-IncludeChildProcess [<SwitchParameter>]

If Process name is stated you can optionally include chile prcesses (recommended)



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-IPAddress <String>

Enter the IPv4 or IPv6 address. Partial strings are allowed. For example, if you enter 192.168, an address of

192.168.0.1 will be considered to match.



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ComputerName <String>

Enter the Full Distinguished Name of the computer object, or the computer name (wildcards accepted). Must be

in the format ComputerName@Domain



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-OU <String>

You can specify an Active Directory Container and the assignment will be effective for all of the objects in

that container. Enter the Full Distinguished Name of the container.



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-EnvironmentVariable <String>

By Specifying an environment variable, you can customize rules in various other ways. A very useful example

for this option is when using it with RDSH, XenApp, or other remote sessions. You can use the Environment

Variable CLIENTNAME to limit visibility to the device being used to access the RDSH or XenApp system.

The environment variables that are supported are the ones that are present when the user's session is created.

Environment variables set during logon are not supported.



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-InputObject <Object>



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>A sample command that uses the function or script, optionaly followed



by sample output and a description. Repeat this keyword for each example.











RELATED LINKS





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Add-FslRule; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Add-FslRule [-Path] <string> [-FullName] <string> [-ValueData] <string[]> [[-Comment]

<string>] [-Passthru] [-RegValueType <string>] [<CommonParameters>]



Add-FslRule [-Path] <string> [-FullName] <string> [-DiskFile] <string> [[-Comment]

<string>] [-Passthru] [<CommonParameters>]



Add-FslRule [-Path] <string> [-FullName] <string> [-RedirectDestPath] <string>

[-RedirectType] <string> [-CopyObject] [[-Comment] <string>] [-Passthru]

[<CommonParameters>]



Add-FslRule [-Path] <string> [-FullName] <string> [-HidingType] <string> [[-Comment]

<string>] [-Passthru] [<CommonParameters>]



Add-FslRule [-Path] <string> [[-Comment] <string>] [-Passthru] [-RuleObject <Rule>]

[<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Add-FslRule

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Compare-FslFilePath; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Compare-FslFilePath [[-OutputPath] <string>] [<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Compare-FslFilePath

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Compare-FslRuleFile; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Compare-FslRuleFile [-Files] <array> [[-OutputPath] <string>] [<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Compare-FslRuleFile

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Get-FslAssignment; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Get-FslAssignment [-Path] <string> [<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Get-FslAssignment

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Get-FslLicenseDay; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Get-FslLicenseDay [-Path] <string> [<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Get-FslLicenseDay

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Get-FslRule; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Get-FslRule [-Path] <string> [<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Get-FslRule

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Remove-FslAssignment; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Remove-FslAssignment [-Path] <string> -Name <string> [-Force] [-WhatIf] [-Confirm]

[<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Remove-FslAssignment

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Remove-FslRule; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Remove-FslRule [-Path] <string> [-Name] <string> [-WhatIf] [-Confirm] [<CommonParameters>]



ModuleName : FSLogix.PowerShell.Rules

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Remove-FslRule

Category : Function

Component :

Role :

Functionality :