Set-SCOMLocation

Set-SCOMLocation

Associates agent-managed computers, management servers, or resource pools with a location.

Syntax

Parameter Set: FromAgent
Set-SCOMLocation [-Agent] <AgentManagedComputer[]> -Location <EnterpriseManagementObject> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-PassThru] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromManagementServer
Set-SCOMLocation [-ManagementServer] <ManagementServer[]> -Location <EnterpriseManagementObject> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-PassThru] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromPool
Set-SCOMLocation [-Pool] <ManagementServicePool[]> -Location <EnterpriseManagementObject> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-PassThru] [-SCSession <Connection[]> ] [ <CommonParameters>]

Detailed Description

The Set-SCOMLocation cmdlet associates one or more agent-managed computers, management servers, or resource pools with a location. This cmdlet removes a current association, if one exists. The Web Application Availability Monitoring Summary Map Dashboard displays state information for agents, management servers, and resource pools associated with a location.

You can remove an association by using the Remove-SCOMLocation cmdlet. You can create a location by using the New-SCOMLocation cmdlet.

By default, this cmdlet uses the active persistent connection to a management group. Use the SCSession parameter to specify a different persistent connection. You can create a temporary connection to a management group by using the ComputerName and Credential parameters. For more information, type Get-Help about_OpsMgr_Connections.

Parameters

-Agent<AgentManagedComputer[]>

Specifies an array of AgentManagedComputer objects. To obtain an AgentManagedComputer object, use the Get-SCOMAgent cmdlet.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). To specify the local computer, type the computer name, localhost, or a dot (.).

You must run the System Center Data Access service on the target computer before you use this cmdlet. If you do not specify a computer, the cmdlet uses the computer for the current management group connection.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies a PSCredential object for the management group connection. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

If you specify a computer in the ComputerName parameter, use an account that has access to that computer. The default value is the current user.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Location<EnterpriseManagementObject>

Specifies a location as an EnterpriseManagementObject object. To obtain a location, use the Get-SCOMLocation cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-ManagementServer<ManagementServer[]>

Specifies an array of management server objects. To obtain a management server object, use the Get-SCOMManagementServer cmdlet.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Pool<ManagementServicePool[]>

Specifies an array of resource pool objects. To obtain a resource pool object, use the Get-SCOMResourcePool cmdlet.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCOMManagementGroupConnection cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Associate an agent with a location

This example associates an agent-managed computer named Sever01.Contoso.com with the location Seattle, WA.

The first command gets the location object that has the display name of Seattle, WA, and then stores the object in the $Location variable.

The second command gets the agent object named Server01.Contoso.com, and then stores the object in the $Agent variable.

The third command associates the location stored in the $Location variable with the agent-managed computer stored in the $Agent variable. If you previously associated this agent-managed computer with a location, the command removes that association.

PS C:\> $Location = Get-SCOMLocation -DisplayName "Seattle, WA"
PS C:\> $Agent = Get-SCOMAgent –Name "Server01.Contoso.com"
PS C:\> Set-SCOMLocation –Location $Location –Agent $Agent

Example 2: Associate a management server with a location

This example associates a management server named MgmtServer01.Contoso.com with the location New York, NY.

The first command gets the location object that has the display name of New York, NY, and then stores the object in the $Location variable.

The second command gets the management server object named MgmtServer01.Contoso.com, and stores the object in the $MgmtServer variable.

The third command associates the location stored in the $Location variable with the management server stored in the $MgmtServer variable. If you previously associated this management server with a location, the command removes that association.

PS C:\> $Location = Get-SCOMLocation –DisplayName "New York, NY"
PS C:\> $MgmtServer = Get-SCOMManagementServer –Name "MgmtServer01.Contoso.com"
PS C:\> Set-SCOMLocation –Location $Location –ManagementServer $MgmtServer

Example 3: Associate a resource pool to a location

This example associates a resource pool named Notifications Resource Pool with the location Paris, FR.

The first command gets the location object that has the display name Paris, FR, and then stores the object in the $Location variable.

The second command gets the resource pool named Notifications Resource Pool, and then stores the object in the $Pool variable.

The third command associates the location stored in the $Location variable with the resource pool stored in the $Pool variable. If you previously associated the resource pool with a location, the command removes that association.

PS C:\> $Location = Get-SCOMLocation –DisplayName "Paris, FR"
PS C:\> $Pool = Get-SCOMResourcePool –Name "Notifications Resource Pool"
PS C:\> Set-SCOMLocation –Location $Location –Pool $Pool

Get-SCOMLocation

New-SCOMLocation

Remove-SCOMLocation

Update-SCOMLocation

Get-SCOMAgent

Get-SCOMManagementServer

Get-SCOMResourcePool

Get-SCOMManagementGroupConnection

Get-Credential