HelpCache/MSFT_DtcNetworkSettingTask_v1.0.cdxml-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DtcNetworkSetting</command:name> <maml:description> <maml:para>Get-DtcNetworkSetting retrieves the DTC network and security configuration settings for the DTC service specified by the DtcName parameter.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>DtcNetworkSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-DtcNetworkSetting retrieves the DTC network and security configuration settings for the DTC service specified by the DtcName parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DtcNetworkSetting</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC network and security configuration settings to return by the DTC instance. If this parameter is null or set to Local, this will return the DTC network and security configuration settings for the Local DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC network and security configuration settings to return by the DTC instance. If this parameter is null or set to Local, this will return the DTC network and security configuration settings for the Local DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-DtcNetworkSetting -DtcName Local AuthenticationLevel : Mutual InboundTransactionsEnabled : True LUTransactionsEnabled : True OutboundTransactionsEnabled : True RemoteAdministrationAccessEnabled : True RemoteClientAccessEnabled : True XATransactionsEnabled : True</dev:code> <dev:remarks> <maml:para>Retrieve the Network and Security configuration settings for the Local DTC instance. This example will also work for any named DTC instance.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=317160 </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DtcNetworkSetting</command:name> <maml:description> <maml:para>Set-DtcNetworkSetting modifies the DTC network and security configuration for the DTC service specified by the DtcName parameter. Set-DtcNetworkSetting will restart the DTC service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>DtcNetworkSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-DtcNetworkSetting modifies the DTC network and security configuration for the DTC service specified by the DtcName parameter. Set-DtcNetworkSetting will restart the DTC service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DtcNetworkSetting</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>AuthenticationLevel</maml:name> <maml:description> <maml:para>Sets the network authentication level of the DTC instance to NoAuth, Incoming, or Mutual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>InboundTransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables inbound transactions to the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>LUTransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables LU transactions in the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>OutboundTransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables outbound transactions from the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>RemoteAdministrationAccessEnabled</maml:name> <maml:description> <maml:para>Enables or Disables remote administration access for the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>RemoteClientAccessEnabled</maml:name> <maml:description> <maml:para>Enables or Disables remote client access for the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>XATransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables XA transactions in the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-DtcNetworkSetting</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DisableNetworkAccess</maml:name> <maml:description> <maml:para>Disables network access for the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DisableNetworkAccess</maml:name> <maml:description> <maml:para>Disables network access for the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>AuthenticationLevel</maml:name> <maml:description> <maml:para>Sets the network authentication level of the DTC instance to NoAuth, Incoming, or Mutual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>InboundTransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables inbound transactions to the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>LUTransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables LU transactions in the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>XATransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables XA transactions in the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>OutboundTransactionsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables outbound transactions from the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>RemoteAdministrationAccessEnabled</maml:name> <maml:description> <maml:para>Enables or Disables remote administration access for the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>RemoteClientAccessEnabled</maml:name> <maml:description> <maml:para>Enables or Disables remote client access for the DTC instance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Change the Network and Security settings for the Local DTC instance. PS C:\> Set-DtcNetworkSetting -DtcName Local -AuthenticationLevel Incoming -InboundTransactionsEnabled 0 Verify the changes now with Get-DtcNetworkSetting. PS C:\> Get-DtcNetworkSetting -DtcName Local __GENUS : 2 __CLASS : DtcNetworkSettings __SUPERCLASS : __DYNASTY : DtcNetworkSettings __RELPATH : __PROPERTY_COUNT : 7 __DERIVATION : {} __SERVER : __NAMESPACE : __PATH : AuthenticationLevel : Mutual InboundTransactionsEnabled : True LUTransactionsEnabled : True OutboundTransactionsEnabled : True RemoteAdministrationAccessEnabled : True RemoteClientAccessEnabled : True XATransactionsEnabled : True</dev:code> <dev:remarks> <maml:para>A basic example of how to use Set-DtcNetworkSetting to change DTC Network and Security settings.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=317178 </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |