Edit

Share via


Get-CMBoundaryGroupSiteSystem

Get site systems in the specified boundary group

Syntax

SearchByName (Default)

Get-CMBoundaryGroupSiteSystem
    [-GroupName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

SearchByIdMandatory

Get-CMBoundaryGroupSiteSystem
    -Id <String[]>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

ByValue

Get-CMBoundaryGroupSiteSystem
    [-InputObject <IResultObject>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

Description

Use this cmdlet to get site systems in the specified boundary group. For more information, see About boundary groups in Configuration Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Display FQDNs of site systems in a boundary group

This example first gets a boundary group by name and saves that object in a variable $boundaryGroup. It then queries for the site systems in that boundary group by passing the boundary group object, and saves the results in a variable $bgSiteSystems.

The foreach loop then goes through each site system object and extracts the FQDN from the NAL path.

$bgName = "Contoso HQ BG"
$boundaryGroup = Get-CMBoundaryGroup -Name $bgName

$bgSiteSystems = Get-CMBoundaryGroupSiteSystem -InputObject $boundaryGroup

foreach ($system in $bgSiteSystems) {
  Write-Host $system.ServerNalPath.TrimEnd('\').Split('\')[-1]
}

Parameters

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
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

-GroupName

Specify a boundary group name to get the associated site systems.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False

Parameter sets

SearchByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specify an array of boundary group IDs to get the associated site systems. This value is an integer, for example 5.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:GroupId

Parameter sets

SearchByIdMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify a boundary group object to get the associated site systems. To get this object, use the Get-CMBoundaryGroup cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:BoundaryGroup

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:True
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.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject

IResultObject

Notes

For more information on this return object and its properties, see SMS_BoundaryGroupSiteSystems server WMI class.