Get-RASFSLogixUser

NAME

Get-RASFSLogixUser

SYNOPSIS

Retrieves an Inclusion/Exclusion List of the Profile Container.

SYNTAX

Get-RASFSLogixUser -DefObjType** {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings | VDIGuestDef} -UserListType {Inclusion | Exclusion} [GeneralSettings (SwitchParameter)] [OfficeContainer (SwitchParameter)] [ProfileContainer (SwitchParameter)] [SiteId (uint)] [(CommonParameters)]

Get-RASFSLogixUser [Id] (uint)** -ObjType {RDSHost | RDS | RDSHostPool | RDSGroup | VDIHostPool | VDIPool | AVDHostPool} -UserListType {Inclusion | Exclusion} [GeneralSettings (SwitchParameter)] [OfficeContainer (SwitchParameter)] [ProfileContainer (SwitchParameter)] [(CommonParameters)]

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

DESCRIPTION

Retrieves an Inclusion/Exclusion List of the Profile Container within the FSLogix settings from 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

Name (string)

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to retrieve 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 retrieve the FSLogix settings.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ObjType

(FSLogixServerObjType) The Object Type for which to retrieve 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 retrieve 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)

Retrieve the Profile Container settings.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

OfficeContainer (SwitchParameter)

Retrieves the Office Container settings.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

GeneralSettings (SwitchParameter)

Retrieves the General settings.

        Required?                    false

        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

UserFilter

EXAMPLES

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

Get-RASFSLogixUser -DefObjType RDSDef -ProfileContainer -UserListType Inclusion

Retrieves the Inclusion List of the Profile Container within the FSLogix Settings of the RDS Default Settings. ---------- EXAMPLE 2 ----------

Get-RASFSLogixUser -Name "RDSHostPool1" -ObjType RDSHostPool -ProfileContainer -UserListType Exclusion

Retrieves the Exclusion List of the Profile Container within the FSLogix Settings of the specified RDSHostPool by Name.

RELATED LINKS

• Get-RASFSLogix

• Set-RASFSLogix

• Add-RASFSLogixUser

• Remove-RASFSLogixUser