Set-SCOMWebAddressSetting

Set-SCOMWebAddressSetting

Sets the URLs for the web console and for online product knowledge.

Syntax

Parameter Set: Empty
Set-SCOMWebAddressSetting [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-OnlineProductKnowledgeUrl <Uri> ] [-PassThru] [-SCSession <Connection[]> ] [-WebConsoleUrl <Uri> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-SCOMWebAddressSetting cmdlet sets the URLs for the web console and for online product knowledge of a management group.

The web console is a browser-based application that enables users to monitor management group data from the Internet.

Product knowledge is the collection of notes that are attached to objects in a management pack. These notes document issues and suggested resolutions for those issues.

Parameters

-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 (.).

The computer must run the System Center Data Access service.

If you do not specify this parameter, the default is 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 the user account under which the management group connection runs. Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, for this parameter. For more information about credential objects, 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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-OnlineProductKnowledgeUrl<Uri>

Specifies the URL for online product knowledge.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Indicates that the cmdlet creates or modifies an object that a command can use in the pipeline. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Specifies an array of Connection objects. To get Connection objects, specify the Get-SCOMManagementGroupConnection cmdlet.

If you do not specify a value for this parameter, the 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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-WebConsoleUrl<Uri>

Specifies the URL for the web console.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

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: Set the web console URL for a management group

This command sets the web console URL to http://OM01.contoso.com/OperationsManager.

PS C:\> Set-SCOMWebAddressSetting -WebConsoleUrl "http://OM01.contoso.com/OperationsManager"

Example 2: Set the product knowledge URL for a management group

This command sets the online product knowledge URL to http://OM01.contoso.com/Knowledge.

PS C:\> Set-SCOMWebAddressSetting -OnlineProductKnowledgeUrl "http://OM01.contoso.com/Knowledge"

Get-SCOMManagementGroupConnection

Get-SCOMWebAddressSetting