Edit

Share via


Set-AdfsFarmInformation

Removes a stale or offline farm node from the farm information table.

Syntax

Default (Default)

Set-AdfsFarmInformation
    [-RemoveNode <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AdfsFarmInformation cmdlet removes a stale or offline farm node from the farm information table in order to keep the list of Active Directory Federation Services (AD FS) farm nodes current.

Examples

Example 1: Remove a stale node

PS C:\> Set-AdfsFarmInformation -RemoveNode "adfs02.contoso.com"

This command removes the node named adfs02.contoso.com from the farm information table.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveNode

Specifies an array of fully qualified domain names (FQDN) of AD FS farm nodes to remove from the farm information table.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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