Chapters/writing-full-help/Solution/TMSample/en-US/TMSample-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-TMServiceLogon</command:name> <command:verb>Get</command:verb> <command:noun>TMServiceLogon</command:noun> <maml:description><maml:para>Get service logon information. </maml:para> </maml:description> </command:details> <maml:description><maml:para>This command uses either CIM (default) or WMI to get the service logon user name on one or more remote machines. You must run this command as a user who has permission to perform this task, remotely, on the computers involved. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-TMServiceLogon</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>The name of the service. Query the Win32_Service class to verify that you know the correct name. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>One or more computer names. Using IP addresses will fail with CIM; they will work with WMI. CIM is always attempted first. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ErrorLogFilePath</maml:name> <maml:Description><maml:para>If provided, this is a path and filename of a text file where failed computer names will be logged. </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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>One or more computer names. Using IP addresses will fail with CIM; they will work with WMI. CIM is always attempted first. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ErrorLogFilePath</maml:name> <maml:Description><maml:para>If provided, this is a path and filename of a text file where failed computer names will be logged. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>The name of the service. Query the Win32_Service class to verify that you know the correct name. </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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>v1.0.0.0 </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-TMServiceLogon -computer server01 -service LobSvc ServiceName ComputerName AccountName ----------- ------------ ----------- LOBSVC server01 company\lob</dev:code> <dev:remarks><maml:para>Get the service account name for the LobSvc. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-CimInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-TMServiceLogon</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command: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-TMServiceLogon</command:name> <command:verb>Set</command:verb> <command:noun>TMServiceLogon</command:noun> <maml:description><maml:para>Sets service login name and password. </maml:para> </maml:description> </command:details> <maml:description><maml:para>This command uses either CIM (default) or WMI to set the service password, and optionally the logon user name, for a service, which can be running on one or more remote machines. You must run this command as a user who has permission to perform this task, remotely, on the computers involved. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-TMServiceLogon</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>The name of the service. Query the Win32_Service class to verify that you know the correct name. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>One or more computer names. Using IP addresses will fail with CIM; they will work with WMI. CIM is always attempted first. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>NewPassword</maml:name> <maml:Description><maml:para>A plain-text string of the new password. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>NewUser</maml:name> <maml:Description><maml:para>Optional; the new logon user name, in DOMAIN\USER format. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>ErrorLogFilePath</maml:name> <maml:Description><maml:para>If provided, this is a path and filename of a text file where failed computer names will be logged. </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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>One or more computer names. Using IP addresses will fail with CIM; they will work with WMI. CIM is always attempted first. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>ErrorLogFilePath</maml:name> <maml:Description><maml:para>If provided, this is a path and filename of a text file where failed computer names will be logged. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>NewPassword</maml:name> <maml:Description><maml:para>A plain-text string of the new password. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>NewUser</maml:name> <maml:Description><maml:para>Optional; the new logon user name, in DOMAIN\USER format. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>The name of the service. Query the Win32_Service class to verify that you know the correct name. </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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>version 1.0.0.0 </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-TMServiceLogon -computer SERVER01 -ServiceName Bits -NewPassword 'P@$$w0rd'</dev:code> <dev:remarks><maml:para>This will set the password of the Bits service on computer SERVER01 to the new value. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2</maml:title> <dev:code>PS C:\> Get-Content c:\files\lobservers.txt | Set-TMServiceLogon -ServiceName LobSvc -NewUser company\lobsvc -NewPassword 'P@$$w0rd' -errorLogFilePath c:\files\svcerrors.txt</dev:code> <dev:remarks><maml:para>In this example, PowerShell will get all of the servers listed in the text file, lobservers.txt and pipe them to the Set-TMServiceLogon. This command will then configure the LobSvc service to a new user and password. Errors will be logged to C:\files\svcerrors.txt. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-CimInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-TMServiceLogon</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |