Citrix Virtual Apps and Desktops SDK

Add-MonitorDirectorAgent

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Returns a boolean

Syntax

Add-MonitorDirectorAgent
   -Component <String>
   -Fqdn <String>
   [-ResourceLocationId <Guid>]
   [-ResourceLocationName <String>]
   [-Domain <String>]
   [-Username <String>]
   [-Password <String>]
   [-Token <String>]
   [-Mode <String>]
   [-IsAgentUpgrade <Boolean>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns a boolean stating whether respective stack monitoring agent is registered successfully

Examples

EXAMPLE 1

Registers the agent and saves its information in Monitor DB

Add-MonitorDirectorAgent -ComponentType "PVS" -Hostname "AWPVS-1HBF0.bvt.local"
<!--NeedCopy-->

Parameters

-Component

Type of component this agent is installed on

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Fqdn

FQDN for the machine where the component and agent are installed

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ResourceLocationId

Resource location the agent is targeted for

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ResourceLocationName

Resource location name the agent is targeted for

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-Domain

Domain for the admin user

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Username

Username for the admin user

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Password

Password for the admin user

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Token

One-Time registration token to be checked for successful registration

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Mode

Mode of Director Agent Installation - Manual/Auto

Type: String
Accepted values: Manual, Auto
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2503

-IsAgentUpgrade

Is Agent Upgrade Required

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2503

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Boolean

Returns a boolean stating whether respective stack monitoring agent is registered successfully

Add-MonitorDirectorAgent