Citrix Virtual Apps and Desktops SDK

Remove-MonitorDirectorAgent

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Returns a boolean

Syntax

Remove-MonitorDirectorAgent
      [-Component <String>]
      [-Fqdn <String>]
      [-ResourceLocationId <Guid>]
      [-AgentId <Guid>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

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

Examples

EXAMPLE 1

Deregisters the agent and saves its information in Monitor DB

Remove-MonitorDirectorAgent -ComponentType "PVS" -Fqdn "AWPVS-1HBF0.bvt.local -ResourceLocationId "4068b075-2e31-4686-ad3c-2300b16fcfd2"
<!--NeedCopy-->

Parameters

-Component

Type of component this agent is installed on

Type:	String
Position:	Named
Default value:	None
Required:	False
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:	False
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

-AgentId

AgentId the agent is targeted for

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

-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

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 deregistered successfully

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-MonitorDirectorAgent

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Remove-MonitorDirectorAgent

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Component

-Fqdn

-ResourceLocationId

-AgentId

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Boolean

Related Links

In this article