Skip to content

Commit 1ddf88e

Browse files
chrisdachrisda
committed
Parameter set fixes
1 parent d421d40 commit 1ddf88e

File tree

2 files changed

+173
-163
lines changed

2 files changed

+173
-163
lines changed

‎exchange/exchange-ps/exchange/mail-flow/New-SendConnector.md

Lines changed: 148 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -17,61 +17,85 @@ For information about the parameter sets in the Syntax section below, see Exchan
1717

1818
## SYNTAX
1919

20-
### Set1
21-
```
22-
New-SendConnector [-Name] <String> -AddressSpaces <MultiValuedProperty>
23-
[-AuthenticationCredential <PSCredential>] [-Comment <String>] [-Confirm]
24-
[-ConnectionInactivityTimeOut <EnhancedTimeSpan>] [-Custom] [-DNSRoutingEnabled <$true | $false>]
25-
[-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-Enabled <$true | $false>]
26-
[-ErrorPolicies <Default | DowngradeAuthFailures | DowngradeDnsFailures>] [-Force]
27-
[-ForceHELO <$true | $false>] [-Fqdn <Fqdn>] [-IgnoreSTARTTLS <$true | $false>] [-Internal] [-Internet]
28-
[-IsCoexistenceConnector <$true | $false>] [-IsScopedConnector <$true | $false>] [-MaxMessageSize <Unlimited>]
29-
[-Partner] [-Port <Int32>] [-ProtocolLoggingLevel <None | Verbose>] [-RequireOorg <$true | $false>]
30-
[-RequireTLS <$true | $false>]
31-
[-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>]
32-
[-SmartHosts <MultiValuedProperty>] [-SmtpMaxMessagesPerConnection <Int32>] [-SourceIPAddress <IPAddress>]
33-
[-SourceTransportServers <MultiValuedProperty>]
34-
[-TlsAuthLevel <EncryptionOnly | CertificateValidation | DomainValidation>]
35-
[-TlsDomain <SmtpDomainWithSubdomains>] [-Usage <Custom | Internal | Internet | Partner>]
36-
[-UseExternalDNSServersEnabled <$true | $false>] [-WhatIf] [<CommonParameters>]
37-
```
38-
39-
### Set2
20+
### AddressSpaces
4021
```
41-
New-SendConnector [-Name] <String> [-AuthenticationCredential <PSCredential>] [-Comment <String>] [-Confirm]
42-
[-ConnectionInactivityTimeOut <EnhancedTimeSpan>] [-Custom] [-DNSRoutingEnabled <$true | $false>]
43-
[-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-Enabled <$true | $false>]
44-
[-ErrorPolicies <Default | DowngradeAuthFailures | DowngradeDnsFailures>] [-Force]
45-
[-ForceHELO <$true | $false>] [-Fqdn <Fqdn>] [-IgnoreSTARTTLS <$true | $false>] [-Internal] [-Internet]
46-
[-IsCoexistenceConnector <$true | $false>] [-LinkedReceiveConnector <ReceiveConnectorIdParameter>]
47-
[-MaxMessageSize <Unlimited>] [-Partner] [-Port <Int32>] [-ProtocolLoggingLevel <None | Verbose>]
48-
[-RequireOorg <$true | $false>] [-RequireTLS <$true | $false>]
22+
New-SendConnector -Name <String> -AddressSpaces <MultiValuedProperty>
23+
[-AuthenticationCredential <PSCredential>]
24+
[-CloudServicesMailEnabled <$true | $false>]
25+
[-Comment <String>]
26+
[-Confirm]
27+
[-ConnectionInactivityTimeOut <EnhancedTimeSpan>]
28+
[-ConnectorType <Default | XPremises>]
29+
[-Custom]
30+
[-DNSRoutingEnabled <$true | $false>]
31+
[-DomainController <Fqdn>]
32+
[-DomainSecureEnabled <$true | $false>]
33+
[-Enabled <$true | $false>]
34+
[-ErrorPolicies <Default | DowngradeDnsFailures | DowngradeCustomFailures | UpgradeCustomFailures>]
35+
[-Force]
36+
[-ForceHELO <$true | $false>]
37+
[-Fqdn <Fqdn>]
38+
[-FrontendProxyEnabled <$true | $false>]
39+
[-IgnoreSTARTTLS <$true | $false>]
40+
[-Internal]
41+
[-Internet]
42+
[-IsCoexistenceConnector <$true | $false>]
43+
[-IsScopedConnector <$true | $false>]
44+
[-MaxMessageSize <Unlimited>]
45+
[-Partner]
46+
[-Port <Int32>]
47+
[-ProtocolLoggingLevel <None | Verbose>]
48+
[-RequireOorg <$true | $false>]
49+
[-RequireTLS <$true | $false>]
4950
[-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>]
50-
[-SmartHosts <MultiValuedProperty>] [-SmtpMaxMessagesPerConnection <Int32>] [-SourceIPAddress <IPAddress>]
51+
[-SmartHosts <MultiValuedProperty>]
52+
[-SmtpMaxMessagesPerConnection <Int32>]
53+
[-SourceIPAddress <IPAddress>]
5154
[-SourceTransportServers <MultiValuedProperty>]
5255
[-TlsAuthLevel <EncryptionOnly | CertificateValidation | DomainValidation>]
53-
[-TlsDomain <SmtpDomainWithSubdomains>] [-Usage <Custom | Internal | Internet | Partner>]
54-
[-UseExternalDNSServersEnabled <$true | $false>] [-WhatIf] [<CommonParameters>]
55-
```
56-
57-
### (Default)
58-
```
59-
New-SendConnector -Name <String> -AddressSpaces <MultiValuedProperty>
60-
[-AuthenticationCredential <PSCredential>] [-CloudServicesMailEnabled <$true | $false>] [-Comment <String>]
61-
[-Confirm] [-ConnectionInactivityTimeOut <EnhancedTimeSpan>] [-Custom] [-DNSRoutingEnabled <$true | $false>]
62-
[-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-Enabled <$true | $false>]
63-
[-ErrorPolicies <Default | DowngradeDnsFailures | DowngradeCustomFailures | UpgradeCustomFailures>] [-Force]
64-
[-ForceHELO <$true | $false>] [-Fqdn <Fqdn>] [-FrontendProxyEnabled <$true | $false>]
65-
[-IgnoreSTARTTLS <$true | $false>] [-Internal] [-Internet] [-IsScopedConnector <$true | $false>]
66-
[-MaxMessageSize <Unlimited>] [-Partner] [-Port <Int32>] [-ProtocolLoggingLevel <None | Verbose>]
67-
[-RequireOorg <$true | $false>] [-RequireTLS <$true | $false>]
56+
[-TlsCertificateName <SmtpX509Identifier>]
57+
[-TlsDomain <SmtpDomainWithSubdomains>]
58+
[-Usage <Custom | Internal | Internet | Partner>]
59+
[-UseExternalDNSServersEnabled <$true | $false>]
60+
[-WhatIf] [<CommonParameters>]
61+
```
62+
63+
### LinkedReceiveConnector
64+
```
65+
New-SendConnector [-Name] <String> [-LinkedReceiveConnector <ReceiveConnectorIdParameter>]
66+
[-AuthenticationCredential <PSCredential>]
67+
[-Comment <String>]
68+
[-Confirm]
69+
[-ConnectionInactivityTimeOut <EnhancedTimeSpan>]
70+
[-Custom]
71+
[-DNSRoutingEnabled <$true | $false>]
72+
[-DomainController <Fqdn>]
73+
[-DomainSecureEnabled <$true | $false>]
74+
[-Enabled <$true | $false>]
75+
[-ErrorPolicies <Default | DowngradeAuthFailures | DowngradeDnsFailures>]
76+
[-Force]
77+
[-ForceHELO <$true | $false>]
78+
[-Fqdn <Fqdn>]
79+
[-IgnoreSTARTTLS <$true | $false>]
80+
[-Internal]
81+
[-Internet]
82+
[-IsCoexistenceConnector <$true | $false>]
83+
[-MaxMessageSize <Unlimited>]
84+
[-Partner]
85+
[-Port <Int32>]
86+
[-ProtocolLoggingLevel <None | Verbose>]
87+
[-RequireOorg <$true | $false>]
88+
[-RequireTLS <$true | $false>]
6889
[-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>]
69-
[-SmartHosts <MultiValuedProperty>] [-SmtpMaxMessagesPerConnection <Int32>] [-SourceIPAddress <IPAddress>]
90+
[-SmartHosts <MultiValuedProperty>]
91+
[-SmtpMaxMessagesPerConnection <Int32>]
92+
[-SourceIPAddress <IPAddress>]
7093
[-SourceTransportServers <MultiValuedProperty>]
7194
[-TlsAuthLevel <EncryptionOnly | CertificateValidation | DomainValidation>]
72-
[-TlsCertificateName <SmtpX509Identifier>] [-TlsDomain <SmtpDomainWithSubdomains>]
73-
[-Usage <Custom | Internal | Internet | Partner>] [-UseExternalDNSServersEnabled <$true | $false>] [-WhatIf]
74-
[-ConnectorType <Default | XPremises>] [-Region <NotSpecified | NAM | EUR | APC>] [<CommonParameters>]
95+
[-TlsDomain <SmtpDomainWithSubdomains>]
96+
[-Usage <Custom | Internal | Internet | Partner>]
97+
[-UseExternalDNSServersEnabled <$true | $false>]
98+
[-WhatIf] [<CommonParameters>]
7599
```
76100

77101
## DESCRIPTION
@@ -153,7 +177,7 @@ Although you can configure non-SMTP address spaces on a Send connector in the Tr
153177
154178
```yaml
155179
Type: MultiValuedProperty
156-
Parameter Sets: Set1, (All)
180+
Parameter Sets: AddressSpaces
157181
Aliases:
158182
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
159183
Required: True
@@ -180,6 +204,29 @@ Accept pipeline input: False
180204
Accept wildcard characters: False
181205
```
182206
207+
### -CloudServicesMailEnabled
208+
Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx).
209+
210+
The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers.
211+
212+
Valid values are:
213+
214+
- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages.
215+
216+
- $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector.
217+
218+
```yaml
219+
Type: $true | $false
220+
Parameter Sets: AddressSpaces
221+
Aliases:
222+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
223+
Required: False
224+
Position: Named
225+
Default value: None
226+
Accept pipeline input: False
227+
Accept wildcard characters: False
228+
```
229+
183230
### -Comment
184231
The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".
185232
@@ -233,6 +280,25 @@ Accept pipeline input: False
233280
Accept wildcard characters: False
234281
```
235282
283+
### -ConnectorType
284+
The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Office 365. Valid values are:
285+
286+
- Default: The connector isn't used to send messages to Office 365. This is the default value.
287+
288+
- XPremises: The connector is used to send messages to Office 365.
289+
290+
```yaml
291+
Type: Default | XPremises
292+
Parameter Sets: AddressSpaces
293+
Aliases:
294+
Applicable: Exchange Server 2016, Exchange Server 2019
295+
Required: False
296+
Position: Named
297+
Default value: None
298+
Accept pipeline input: False
299+
Accept wildcard characters: False
300+
```
301+
236302
### -Custom
237303
The Custom parameter specifies the Custom usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom parameter, you can't use any of the following parameters:
238304
@@ -416,6 +482,21 @@ Accept pipeline input: False
416482
Accept wildcard characters: False
417483
```
418484
485+
### -FrontendProxyEnabled
486+
The FrontendProxyEnabled parameter routes outbound messages through the CAS server, where destination specific routing, such as DNS or IP address, is set, when the parameter is set to $true.
487+
488+
```yaml
489+
Type: $true | $false
490+
Parameter Sets: AddressSpaces
491+
Aliases:
492+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
493+
Required: False
494+
Position: Named
495+
Default value: None
496+
Accept pipeline input: False
497+
Accept wildcard characters: False
498+
```
499+
419500
### -IgnoreSTARTTLS
420501
The IgnoreSTARTTLS parameter specifies whether to ignore the StartTLS option offered by a remote sending server. This parameter is used with remote domains. This parameter must be set to $false if the RequireTLS parameter is set to $true. Valid values for this parameter are $true or $false.
421502
@@ -488,7 +569,7 @@ The IsCoexistenceConnector parameter specifies whether this Send connector is us
488569
489570
```yaml
490571
Type: $true | $false
491-
Parameter Sets: Set1, Set2
572+
Parameter Sets: (All)
492573
Aliases:
493574
Applicable: Exchange Server 2010
494575
Required: False
@@ -503,7 +584,7 @@ The IsScopedConnector parameter specifies the availability of the connector to o
503584
504585
```yaml
505586
Type: $true | $false
506-
Parameter Sets: Set1, (All)
587+
Parameter Sets: AddressSpaces
507588
Aliases:
508589
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
509590
Required: False
@@ -538,7 +619,7 @@ When you use the LinkedReceiveConnector parameter, you can't use the AddressSpac
538619
539620
```yaml
540621
Type: ReceiveConnectorIdParameter
541-
Parameter Sets: Set2
622+
Parameter Sets: LinkedReceiveConnector
542623
Aliases:
543624
Applicable: Exchange Server 2010
544625
Required: False
@@ -766,6 +847,21 @@ Accept pipeline input: False
766847
Accept wildcard characters: False
767848
```
768849
850+
### -TlsCertificateName
851+
The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\<I\>X.500Issuer\<S\>X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \<Thumbprint\>, run the command $TLSCertName = "\<I\>$($TLSCert.Issuer)\<S\>$($TLSCert.Subject)", and then use the value $TLSCertName for this parameter.
852+
853+
```yaml
854+
Type: SmtpX509Identifier
855+
Parameter Sets: AddressSpaces
856+
Aliases:
857+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
858+
Required: False
859+
Position: Named
860+
Default value: None
861+
Accept pipeline input: False
862+
Accept wildcard characters: False
863+
```
864+
769865
### -TlsDomain
770866
The TlsDomain parameter specifies the domain name that the Send connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection.
771867
@@ -846,93 +942,6 @@ Accept pipeline input: False
846942
Accept wildcard characters: False
847943
```
848944
849-
### -CloudServicesMailEnabled
850-
Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard (https://technet.microsoft.com/library/hh529921.aspx).
851-
852-
The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers.
853-
854-
Valid values are:
855-
856-
- $true: The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard. Certain X-MS-Exchange-Organization-\* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-\* headers and are thereby preserved in messages. X-MS-Exchange-CrossPremises-\* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-\* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-\* headers that already exist in messages.
857-
858-
- $false: The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector.
859-
860-
```yaml
861-
Type: $true | $false
862-
Parameter Sets: (All)
863-
Aliases:
864-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
865-
Required: False
866-
Position: Named
867-
Default value: None
868-
Accept pipeline input: False
869-
Accept wildcard characters: False
870-
```
871-
872-
### -FrontendProxyEnabled
873-
The FrontendProxyEnabled parameter routes outbound messages through the CAS server, where destination specific routing, such as DNS or IP address, is set, when the parameter is set to $true.
874-
875-
```yaml
876-
Type: $true | $false
877-
Parameter Sets: (All)
878-
Aliases:
879-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
880-
Required: False
881-
Position: Named
882-
Default value: None
883-
Accept pipeline input: False
884-
Accept wildcard characters: False
885-
```
886-
887-
### -TlsCertificateName
888-
The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\<I\>X.500Issuer\<S\>X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \<Thumbprint\>, run the command $TLSCertName = "\<I\>$($TLSCert.Issuer)\<S\>$($TLSCert.Subject)", and then use the value $TLSCertName for this parameter.
889-
890-
```yaml
891-
Type: SmtpX509Identifier
892-
Parameter Sets: (All)
893-
Aliases:
894-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
895-
Required: False
896-
Position: Named
897-
Default value: None
898-
Accept pipeline input: False
899-
Accept wildcard characters: False
900-
```
901-
902-
### -ConnectorType
903-
The ConnectorType parameter specifies whether the connector is used in hybrid deployments to send messages to Office 365. Valid values are:
904-
905-
- Default: The connector isn't used to send messages to Office 365. This is the default value.
906-
907-
- XPremises: The connector is used to send messages to Office 365.
908-
909-
```yaml
910-
Type: Default | XPremises
911-
Parameter Sets: (All)
912-
Aliases:
913-
Applicable: Exchange Server 2016, Exchange Server 2019
914-
Required: False
915-
Position: Named
916-
Default value: None
917-
Accept pipeline input: False
918-
Accept wildcard characters: False
919-
```
920-
921-
### -Region
922-
This parameter is reserved for internal Microsoft use.
923-
924-
```yaml
925-
Type: NotSpecified | NAM | EUR | APC
926-
Parameter Sets: (All)
927-
Aliases:
928-
Applicable: Exchange Server 2016, Exchange Server 2019
929-
Required: False
930-
Position: Named
931-
Default value: None
932-
Accept pipeline input: False
933-
Accept wildcard characters: False
934-
```
935-
936945
### CommonParameters
937946
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
938947

0 commit comments

Comments
 (0)