Add-RASFSLogixUser

NAME

Add-RASFSLogixUser

SYNOPSIS

Adds a user to an Inclusion/Exclusion List of the Profile Container.

SYNTAX

Add-RASFSLogixUser -DefObjType** {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -GeneralSettings (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [SiteId (uint)] [(CommonParameters)]

Add-RASFSLogixUser -DefObjType** {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -OfficeContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [SiteId (uint)] [(CommonParameters)]

Add-RASFSLogixUser -DefObjType** {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -ProfileContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [SiteId (uint)] [(CommonParameters)]

Add-RASFSLogixUser [Id] (uint)** -GeneralSettings (SwitchParameter) -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [Id] (uint)** -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -OfficeContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [Id] (uint)** -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [-InputObject] (RASSerilazableObj) -GeneralSettings (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [-InputObject] (RASSerilazableObj) -OfficeContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [-InputObject] (RASSerilazableObj) -ProfileContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [Name]** (string) [[-SiteId] (uint)] -GeneralSettings (SwitchParameter) -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [Name]** (string) [[-SiteId] (uint)] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -OfficeContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

Add-RASFSLogixUser [Name]** (string) [[-SiteId] (uint)] -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -ProfileContainer (SwitchParameter) -UserListType {Inclusion | Exclusion} [Account (string)] [SID (string)] [(CommonParameters)]

DESCRIPTION

Adds a user to an Inclusion/Exclusion List of the Profile Container within the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults

PARAMETERS

UserListType (FSLogixListType)

Specifies the 'User List Type'.

Possible values: Inclusion, Exclusion

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Account (string)

The name of the user/group account to add to the FSLogix Container.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SID (string)

The SID of the user/group account to add to the FSLogix Container.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Name (string)

The name or server for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to modify the FSLogix settings.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

The ID of a server for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject

(RASSerilazableObj) An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ObjType

(FSLogixServerObjType) The Object Type for which to modify the FSLogix settings.

Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

DefObjType (ServerDefObjType)

The Default Object Type for which to modify the FSLogix settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings, VDIGuestDef

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ProfileContainer (SwitchParameter)

Set the Profile Container settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

OfficeContainer (SwitchParameter)

Sets the Office Container settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

GeneralSettings (SwitchParameter)

Sets the General settings.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        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 documentation. 

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

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

Add-RASFSLogixUser -DefObjType RDSDef -ProfileContainer -UserListType Inclusion -Account "JaneDoe"

Adds a user to the Inclusion List of the Profile Container within the FSLogix Settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------

Add-RASFSLogixUser -Name "RDSHostPool1" -ObjType RDSHostPool -ProfileContainer -UserListType Exclusion -Account "SID://DOMAIN/JaneDoe"

Adds a user to the Exclusion List of the Profile Container within the FSLogix Settings of the specified RDSHostPool by Name.

RELATED LINKS

• Get-RASFSLogix

• Set-RASFSLogix

• Get-RASFSLogixUser

• Remove-RASFSLogixUser