SECURE Exchange Gateway (SXG) Interceptor cmdlets

What does it do?

Adds a Gateway to the current list of Gateways

Usage

When you want to assign the interceptor to communicate to a particular Gateway

Related cmdlets

Get-SXGGateway.

Remove-SXGGateway.

Set-SXGGateway.

Syntax

Add-SXGGateway [[-Identity] <GatewayIdentity>] [-URI <string>] [<CommonParameters>]]

Parameters

• -Identity <GatewayIdentity>

  The Gateway you want to add

  Required?	true
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -URI <String>

  The IP address or hostname of the SXG Gateway

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

Add-SXGGateway -Identity GW3

What does it do?

Adds a new set of interception rules

Usage

When you want to add additional rules for determining whether a message should be intercepted across single or multiple sites.

Related cmdlets

Copy-SXGInterceptionRules.

Remove-SXGInterceptionRules.

Set-SXGInterceptionRules.

Syntax

Add-SXGInterceptionRules [[-Identity] <RulesIdentity>] [-AssignedSites <string[]>] [<CommonParameters>]]

Parameters

• -Identity <RulesIdentity>

  The name (or identity) of the rules to be added.

  Required?	true
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -AssignedSites <String[]>

  The name of the sites to which the added rules apply.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will assign the new set of rules called newrules to two sites.

Add-SXGInterceptionRules -Identity newrules -AssignedSites site6, site7

What does it do?

Copies an existing set of interception rules to new or existing rules.

Usage

When you have an existing set of rules that you want to copy to another or multiple sets of rules.

Related cmdlets

Add-SXGInterceptionRules.

Remove-SXGInterceptionRules.

Set-SXGInterceptionRules.

Syntax

Copy-SXGInterceptionRules [[-Identity] <RulesIdentity>] [-TargetIdentity <RulesIdentity>] [-Force] [<CommonParameters>]]

Parameters

• -Identity <RulesIdentity>

  The identity (name) of the rules to be used as the source of the copy.

  Required?	true
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -TargetIdentity <RulesIdentity>

  Name of the target rules.

  Required?	false
  Position?	1
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -Force

  No confirmation requested.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will copy the DefaultRules to rule5 with confirmation prompt.

Copy-SXGInterceptionRules -Identity DefaultRules -TargetIdentity rule5

What does it do?

Displays a list of known Gateways.

Usage

When you want a see a list of Gateways that have been added to the Gateway list, sites they are applied to, and status.

Related cmdlets

Add-SXGGateway.

Remove-SXGGateway.

Set-SXGGateway.

Syntax

Get-SXGGateway [[-Identity] <GatewayIdentity>] [<CommonParameters>]]

Parameters

• -Identity <GatewayIdentity>

  The Gateway you want information on. The name of the Gateway can contain wildcards where * means zero or more characters and ? means one character.

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will retrieve detail for Gateway (gw) 2 and 3.

get-SXGGateway gw[23]

What does it do?

Gets the current values of the interception rules that are stored in AD LDS.

Usage

When you want to see a list of current interception rules and the sites they are assigned to.

Related cmdlets

Add-SXGInterceptionRules.

Copy-SXGInterceptionRules.

Remove-SXGInterceptionRules.

Set-SXGInterceptionRules.

Syntax

Get-SXGInterceptionRules [[-Identity] <RulesIdentity>] [<CommonParameters>]]

Parameters

• -Identity <RulesIdentity>

  The rules you want information on. The name of the rules can contain wildcards where * means zero or more characters and ? means one character.

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will list assigned sites for all current rules.

Get-SXGInterceptionRules

What does it do?

Gets the SXG Interceptor configuration for computers that have the SXG Interceptor installed.

Usage

When you want to see a list of SXG Interceptor in your organization with their state, activity, and queue length.

Related cmdlets

Set-SXGInterceptor.

Syntax

Get-SXGInterceptor [[-Identity] <InterceptorIdentity>] [<CommonParameters>]]

Parameters

• -Identity <InterceptorIdentity>

  The interceptor you want information on. The name of the SXG Interceptor can contain wildcards where * means zero or more characters and ? means one character.

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will list all SXG Interceptors in your organization with summary detail including state and queue length.

Get-SXGInterceptor

The following will list detailed SXG Interceptor information for the transport server HUB1.example.com. The command uses a pipeline operator to pass Get-SXGInterceptor cmdlet data to the Format-List cmdlet.

Get-SXGInterceptor HUB1.example.com | Format-List

What does it do?

Gets details of messages queued on an SXG Interceptor.

Usage

When you want to see details of one or more messages in an SXG Interceptor processing queue.

Related cmdlets

Remove-SXGMessage.

Syntax

Get-SXGMessage [[-Identity] <MessageIdentity>] [-Interceptor <InterceptorIdentity>] [-IncludeSubject] [<CommonParameters>]]

Parameters

• -Identity <MessageIdentity>

  The Job ID of the message whose details you want to see.

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -Interceptor <InterceptorIdentity>

  The identity of the SXG Interceptor from where to get the message details.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	true
  Accept wildcard characters?	true

• -IncludeSubject

  Include the subject in the information returned for each message.

  Required?	false
  Position?	named
  Default value	false
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will list all messages queued on the local host.

Get-SXGMessage

The following will list all messages that are queued on HUB1.example.com in descending order by SXG server. The command uses a pipeline operator to pass Get-SXGMessage cmdlet data to the Format-Table cmdlet.

Get-SXGMessage -Interceptor HUB1.example.com | Sort-Object Gateway, QueuedDuration, -Descending | Format-Table JobId, Sender, Recipients, QueuedDuration, Gateway -Autosize 

What does it do?

Gets the SXG Interceptor settings. including the AD LDS user name and the logging settings used by the SXG Interceptor.

Usage

When you want a see the AD LDS user name and the logging settings used by the SXG Interceptor.

Related cmdlets

Set-SXGSettings.

Syntax

Get-SXGSettings [<CommonParameters>]]

Parameters

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will display the ADLDSUsername and LogLevel used by the SXG Interceptor.

get-SXGSettings

What does it do?

Installs the SXG Interceptor performance counters.

Usage

When you want to install or reinstall the SXG Interceptor performance monitor counters on the local computer.

Related cmdlets

Remove-SXGPerfcounters.

Syntax

Install-SXGPerfCounters [<CommonParameters>]]

Parameters

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

This following command will install or reinstall the SXG Interceptor performance monitor counters on the local computer.

Install-SXGPerfCounters 

What does it do?

Removes an existing Gateway.

Usage

When you want to remove a Gateway.

Related cmdlets

Add-SXGGateway.

Get-SXG-Gateway.

Remove-SXGGateway.

Syntax

Remove-SXGGateway [[-Identity] <GatewayIdentity>] [-Force] [<CommonParameters>]]

Parameters

• -Identity <GatewayIdentity>

  The name of the Gateway. The name can contain wildcards where * means zero or more characters and ? means one character..

  Required?	true
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -Force

  No confirmation requested.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following will remove gw4 from the current set of Gateways with confirmation prompt.

Remove-SXGGateway gw4

What does it do?

Removes a set of interception rules.

Usage

When you want to remove a set of rules that are being used to intercept messages.

Related cmdlets

Add-SXGInterceptionRules.

Get-SXGInterceptionRules.

Set-SXGInterceptionRules.

Syntax

Remove-SXGInterceptionRules [[-Identity] <RulesIdentity>] [-Force] [<CommonParameters>]]

Parameters

• -Identity <RulesIdentity>

  The identity (name) of the rules to be removed.

  Required?	true
  Position?	0
  Default value
  Accept pipeline input?	true
  Accept wildcard characters?	true

• -Force

  No confirmation requested.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following command will remove an existing set of interception rules without confirmation.

Remove-SXGInterceptionRules -Identity rules5 -Force

What does it do?

Removes messages from the SXG Interceptor queue with switches to delete, deliver, or non-deliver the message from the Exchange message transport.

Usage

When you want to remove one or more messages from the SXG Interceptor queue.

Related cmdlets

Get-SXGMessage.

Syntax

Remove-SXGMessage [-Message] <MessageIdentity> [-UniqueId <string>] [-Interceptor <InterceptorIdentity>][-Force] -Deliver [<CommonParameters>]]

Remove-SXGMessage [-Message] <MessageIdentity> [-UniqueId <string>] [-Interceptor <InterceptorIdentity>][-Force] -Delete [<CommonParameters>]]

Remove-SXGMessage [-Message] <MessageIdentity> [-UniqueId <string>] [-Interceptor <InterceptorIdentity>][-Force] -NonDeliver [-Reason <string>] [<CommonParameters>]]

Parameters

• -Message <MessageIdentity>

  The message to be removed

  Required?	true
  Position?	0
  Default value
  Accept pipeline input?	true
  Accept wildcard characters?	true

• -UniqueId <String>

  The unique ID of the message to remove.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -Interceptor <InterceptorIdentity>

  TheSXG Interceptor from where to remove the message.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -Force

  No confirmation requested.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -Deliver

  Deliver the message to the original recipients without waiting for processing to complete.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -Delete

  Delete the message from the Exchange message transport.

  Required?	true
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -NonDeliver

  Do not deliver the message from the Exchange message transport and send a non-delivery report to the sender.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -Reason <String>

  The reason for removing the message.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following command will remove all messages from the local Interceptor queue and will instruct Exchange to deliver the message to the recipient.

Get-SXGMessage | Remove-SXGMessage -Deliver

The following command will remove a message with the specified by message ID from the local Interceptor queue.

Remove-SXGMessage -UniqueId "6d8a2e2f-e57a-4e61-b800-54b8d236cd2f@HUB1.EXAMPLE.COM" –Delete

What does it do?

Configures an existing Gateway.

Usage

When you want to configure and enable an existing Gateway.

Related cmdlets

Add-SXGGateway.

Get-SXGGateway.

Remove-SXGGateway.

Syntax

Set-SXGGateway [[-Identity] <GatewayIdentity>] [-URI <string>] [-Enabled <Boolean>] [-AssignedSites <string[]> [<CommonParameters>]]

Parameters

• -Identity <GatewayIdentity>

  The Gateway to configure. The name can contain wildcards where * means zero or more characters and ? means one character.

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -URI <String>

  The Gateway URI

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -Enabled <Boolean>

  Enable or disable.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -AssignedSites

  A list of strings representing the sites in which the Gateways should reside.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following command sets the URI for gw2 within the current set of Gateways.

Set-SXGGateway gw2 -URI 1.2.3.4

The following command sets the URI, assign sites 2 and 3, and enables gw2 within the current set of Gateways.

Set-SXGGateway gw2 -URI 1.2.3.4 -Enabled $true -AssignedSites site2, site3

What does it do?

Sets interception rules

Usage

When you want to set the rules for determining if a message should be intercepted.

Related cmdlets

Add-SXGInterceptionRules.

Copy-SXGInterceptionRules.

Get-SXGInterceptionRules.

Remove-SXGInterceptionRules

Syntax

Set-SXGInterceptionRules [[-Identity] <RulesIdentity>] [-IntereceptLocalOnly <$true|$false>][-ValidateAddresses <$true|$false>] [-InterceptEmptySenders <$true|$false>] [-TrustedHosts <String[]>] [-FailureAction <Deliver|Delete|NonDeliver>] [-MessageclassLogic <DoNotIntercept|Intercept|NotUsed>] [-MessageClassList <string[]>] [-RecipientaddressLogic <DoNotIntercept|Intercept|NotUsed>] [-RecipientAddressList <String[]>] [-RecipientDomainLogic <DoNotIntercept|Intercept|NotUsed>] [-RecipientDomainList <String[]>][-SenderAddressLogic <DoNotIntercept|Intercept|NotUsed>] [-SenderAddressList <String[]>] [-SenderDomainLogic <DoNotIntercept|Intercept|NotUsed>] [-SenderDomainList <String[]>] [-AssignedSites <String[]>] [<CommonParamters>] ]

 

Parameters

• -Identity <RulesIdentity>

  The name (or identity) of the rules to be updated. The name can contain wildcards where * means zero or more characters and ? means one character.

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -InterceptorLocalOnly <$true|$false>

  Boolean parameter indicating whether only mail from the local store should be intercepted.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -ValidateAddresses <$true|$false>

  Boolean parameter indicating whether addresses in the address lists should be validated before being used.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -InterceptEmptySenders <$true|$false>

  Boolean parameter indicating whether messages with no sender (e.g. NDRs) should be intercepted.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -TrustedHosts <String[]>

  A list of hosts that are trusted to submit mail to the Exchange server without being intercepted.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -FailureAction <Deliver|Delete|NonDeliver]

  The action to take when a message processing failure occurs.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -MessageClassLogic <DoNotIntercept|Intercept|NotUsed>

  The logic to apply to values matching the message class list.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -MessageClassList <String[]>

  The set of message classes to check.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -RecipientAddressLogic <DoNotIntercept|Intercept|NotUsed>

  The logic to apply to values matching the recipient address list.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -RecipientAddressList <String[]>

  The set of recipient email addresses to check.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -RecipientDomainLogic <DoNotIntercept|Intercept|NotUsed>

  The logic to apply to values matching the recipient domain list.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -RecipientDomainList <string[]>

  The set of fully-qualified recipient domain names to check.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -SenderAddressLogic <DoNotIntercept|Intercept|NotUsed>

  The logic to apply to values matching the sender address list.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -SenderAddressList <String[]>

  The set of sender email addresses to check.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -SenderDomainLogic <DoNotIntercept|Intercept|NotUsed>

  The logic to apply to values matching the sender domain list.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -SenderDomainList <String[]>

  The set of fully-qualified sender domain names to check.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -AssignedSites <String[]>

  The name of the sites to which the rules apply.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following command sets the DefaultRules configuration to only intercept mail sent to userA@example.com and userB@example.com.

Set-SXGInterceptionRules DefaultRules -RecipientAddressLogic Intercept -RecipientaddressList userA@example.com,userB@example.com 

The following command sets all rule configurations to not intercept mail sent to Health Mailboxes in example.com.

Set-SXGInterceptionRules -RecipientAddressLogic DoNotIntercept -RecipientaddressList healthmailbox*@example.com 

Refer to the Powershell help for this cmdlet for more examples. From Powershell, type:

help Set-SXGInterceptionRules -examples

 

What does it do?

Sets configuration options for the SXG Interceptors on your organisation.

Usage

When you want to configure one or more SXG Interceptors.

Related cmdlets

Get-SXGInterceptor.

Syntax

Set-SXGInterceptor [[-Identity] <interceptorIdentity>] [-MonitorModeEnabled <$true|$false>] [-ClientID <string>] [-Enabled <$true|$false>] [<CommonParameters>]

Parameters

• -Identity <InterceptorIdentity>

  The SXG Interceptor on which to set the configuration.

  Required?	false
  Position?	0
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	true

• -MonitorModeEnabled <$true|$false>

  Use monitor mode.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -Client ID <String>

  The unique ID assigned to the SXG Interceptor by an SXG Gateway.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -Enabled <$true|$false>

  Enable or disable.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following command sets the SXG Interceptor to enabled.

Set-SXGInterceptor -Identity HUB1 -Enabled $true

The following enables monitor mode for all SXG Interceptors in the organization.

Get-SXGInterceptor | Set-SXGInterceptor -MonitorModeEnabled $true 

What does it do?

Sets the SXG Interceptor configuration store credentials and logging settings.

Usage

When you want to set the SXG Interceptor configuration store credentials and logging settings used by the SXG Interceptor.

Related cmdlets

Get-SXGSettings

Syntax

Set-SXGSettings [-ADLDSUserName <string>] [-ADLDSPassword <SecurityString>] [-LogLevel <Off|Error|warn|Info|Debug>] [<CommonParameters>]]

Parameters

• -ADLDSUserName <string>

  The name of the account to use to authenticate with AD LDS.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -ADLDSPassword <string>

  The password of the account to use to authenticate with AD LDS.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• -LogLevel <Off|Error|Warn|Info|Debug>

  The level of diagnostic logging to emit.

  Required?	false
  Position?	named
  Default value
  Accept pipeline input?	false
  Accept wildcard characters?	false

• <CommonParameters>

  The cmdlet supports the following common parameters: Show me

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

  For more information, from Powereshell type:

  get-help about_commonparameters

Example

The following command will configure the SXG Interceptor to use the Administrator account in the domain 'Example' to access the configuration store with a down-level logon name.

Note that a 'SecureString' MUST be supplied as the value for the -ADLDSPassword parameter. An example method would be the following:

$pwd = read-host -AsSecureString

After pressing Enter, the password should be entered. Each character will be displayed as a '*' character.

The $pwd variable should now be used as the -ADLDSPassword parameter:

Set-SXGSettings -ADLDSUsername Example\Administrator -ADLDSPassword $pwd

Refer to the Powershell help for this cmdlet for more examples. From Powershell, type:

help Set-SXGsettings -examples