Remove-SCOMLocation
Removes associations with a location or deletes a location.
Syntax
FromAgent (Default)
Remove-SCOMLocation
[-Agent] <AgentManagedComputer[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FromManagementServer
Remove-SCOMLocation
[-ManagementServer] <ManagementServer[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FromPool
Remove-SCOMLocation
[-Pool] <ManagementServicePool[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FromLocation
Remove-SCOMLocation
[-Location] <EnterpriseManagementObject[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-SCOMLocation cmdlet removes the association of a location with an agent-managed computer, management server, or resource pool, or it deletes a location. To remove an association, specify agent-managed computers, management servers, or resource pools. To delete a location, specify the location by using the Get-SCOMLocation cmdlet.
You can change a location display name, a latitude, or a longitude by using the Update-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.
Examples
Example 1: Delete a location
PS C:\>$Location = Get-SCOMLocation -DisplayName "Seattle, WA"
PS C:\> Remove-SCOMLocation -Location $Location
This example deletes a location that has the display name Seattle, WA. The first command gets the location object that has the display name Seattle, WA, and then stores the object in the $Location variable.
The second command deletes the location object stored in the $Location variable.
Example 2: Remove an agent-managed computer from a location
PS C:\>$Agent = Get-SCOMAgent -Name "Server73.Contoso.com"
PS C:\> Remove-SCOMLocation -Agent $Agent
This example removes an agent-managed computer named Server73.Contoso.com from its location. The first command gets the agent object for the computer named Server73.Contoso.com and then stores the object in the $Agent variable.
The second command removes the location association from the agent-managed computer object stored in the $Agent variable. This command does not delete the location itself.
Example 3: Remove a management server from a location
PS C:\>$MgmtServer = Get-SCOMManagementServer -Name "MgmtServer01.Contoso.com"
PS C:\> Remove-SCOMLocation -ManagementServer $MgmtServer
This example removes a management server from its location. The first command gets the management server object named MgmtServer01.Contoso.com, and then stores the object in the $MgmtServer variable.
The second command removes the location association from the management server object stored in the $MgmtServer variable. This command does not delete the location itself.
Example 4: Remove a resource pool from a location
PS C:\>$Pool = Get-SCOMResourcePool -Name "Notifications Resource Pool"
PS C:\> Remove-SCOMLocation -Pool $Pool
This example removes a resource pool named Notifications Resource Pool from its location. The first command gets the resource pool object for a resource pool named Notifications Resource Pool, and then stores the object in the $Pool variable.
The second command removes the location association from the resource pool object stored in the $Pool variable. This command does not delete the location itself.
Parameters
-Agent
Specifies an array of AgentManagedComputer objects. To obtain an AgentManagedComputer object, use the Get-SCOMAgent cmdlet.
Parameter properties
| Type: | AgentManagedComputer[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromAgent
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ComputerName
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 (.).
The System Center Data Access service must be running on the computer. If you do not specify a computer, the cmdlet uses the computer for the current management group connection.
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 |
-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 |
-Credential
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 is the current user.
Parameter properties
| Type: | PSCredential |
| 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 |
-Location
Specifies an array of locations as EnterpriseManagementObject objects. To obtain a location, use the Get-SCOMLocation cmdlet.
Parameter properties
| Type: | EnterpriseManagementObject[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromLocation
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ManagementServer
Specifies an array of management server objects. To obtain a management server object, use the Get-SCOMManagementServer cmdlet.
Parameter properties
| Type: | ManagementServer[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromManagementServer
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Pool
Specifies an array of resource pool objects. To obtain a resource pool object, use the Get-SCOMResourcePool cmdlet.
Parameter properties
| Type: | ManagementServicePool[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromPool
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SCSession
Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCOMManagementGroupConnection cmdlet.
Parameter properties
| Type: | Connection[] |
| 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.