Add-RASScheduleTarget.md

NAME

Add-RASScheduleTarget

SYNOPSIS

Adds a new Schedule target.

SYNTAX

Add-RASScheduleTarget [Id] (uint) -ObjType {RDS | VDI | AVD} -TargetID (uint) [-TargetType {Host | HostPool}] [(CommonParameters)]

Add-RASScheduleTarget [Id] (uint) -HostAzureID (string) -ObjType {RDS | VDI | AVD} -PoolId (uint) [-TargetType {Host | HostPool}] [(CommonParameters)]

Add-RASScheduleTarget [Id] (uint) -GuestName (string) -GUID (string) -ObjType {RDS | VDI | AVD} -PoolId (uint) [-TargetType {Host | HostPool}] [(CommonParameters)]

Add-RASScheduleTarget [Name] (string) [[-SiteId] (uint)] -ObjType {RDS | VDI | AVD} -TargetID (uint) [-TargetType {Host | HostPool}] [(CommonParameters)]

Add-RASScheduleTarget [Name] (string) [SiteId] (uint) -HostAzureID (string) -ObjType {RDS | VDI | AVD} -PoolId (uint) [-TargetType {Host | HostPool}] [(CommonParameters)]

Add-RASScheduleTarget [Name] (string) [SiteId] (uint) -GuestName (string) -GUID (string) -ObjType {RDS | VDI | AVD} -PoolId (uint) [-TargetType {Host | HostPool}] [(CommonParameters)]

DESCRIPTION

Creates a new Schedule property.

PARAMETERS

Name (string)

Scheduler job name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID to modify the schedule job.

        Required?                    true

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

Scheduler job ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

ObjType (ScheduleObjType)

Schedule object type.

Possible values: RDS, VDI, AVD

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

TargetType

(ScheduleTargetType) Schedule target type.

Possible values: Host, HostPool

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

TargetID (uint)

The target RD Session Host server or server group Ids depending on the TargetType parameter.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

PoolId (uint)

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

GUID (string)

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

GuestName (string)

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

HostAzureID (string)

        Required?                    true

        Position?                    named

        Default value                

        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

Schedule

EXAMPLES

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

Add-RASScheduleTarget -ObjType VDI -Id 1 -TargetID 1

Adds a schedule target id to the schedule item specified by id. **---------- EXAMPLE 2 ----------

Add-RASScheduleTarget -ObjType VDI -Name "My Schedule" -TargetID 1

Adds a schedule target id to the schedule item specified by name. **---------- EXAMPLE 3 ----------

Add-RASScheduleTarget -ObjType VDI -Id 1 -PoolID 1 -GUID "SampleGUID" -GuestName "SampleGuestName"

Adds a schedule target native host to the schedule item specified by id. **---------- EXAMPLE 4 ----------

Add-RASScheduleTarget -ObjType VDI -Name "My Schedule" -PoolID 1 -HostAzureID "SampleAzureID"

Adds a schedule target native host to the schedule item specified by name.

RELATED LINKS

• Remove-RASScheduleTarget

• Get-RASScheduleTarget