Get-RASFSLogix

NAME

Get-RASFSLogix

SYNOPSIS

Retrieves the FSLogix settings.

SYNTAX

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

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

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

DESCRIPTION

Retrieves the FSLogix settings from RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults.

PARAMETERS

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

OfficeContainerSettings

ProfileContainerSettings

FSLogixGeneralSettings

FSLogixSettings

EXAMPLES

**---------- EXAMPLE 1 ----------

Get-RASFSLogix -DefObjType RDSDef

Retrieves the FSLogix Settings of the RDS Default Settings. **---------- EXAMPLE 2 ----------

Get-RASFSLogix -Name "RDSHostPool1" -ObjType RDSHostPool

Retrieves the FSLogix Settings of the specified RDSHostPool by Name. **---------- EXAMPLE 3 ----------

Get-RASFSLogix -Id 1 -ObjType RDSHostPool

Retrieves the FSLogix Settings of the specified RDSHostPool by Id. **---------- EXAMPLE 4 ----------

Get-RASFSLogix -ProviderId 1 -VDIDesktopId 42311235-09c5-ca15-337d-b9723015edf0

Retrieves the FSLogix Settings of the specified VDIDesktop.

Last updated