HelpCache/MsftSil_ManagementTasks.psm1-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-SilLogging</command:name><maml:description><maml:para>Displays configuration settings for Software Inventory Logging. </maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>SilLogging</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-SilLogging cmdlet displays configuration settings for Software Inventory Logging. If logging is started, Software Inventory Logging collects data daily from all Software Inventory Logging data sources, and then forwards this data over the network to an aggregation server. Specify an aggregation server by using the Set-SilLogging cmdlet. If you do not specify an aggregation server and the server is a virtual machine that runs on a Hyper-V host, then the daily collection forwards the Software Inventory Logging data to a location that its Windows Server host can access. The cmdlet gets the state, either started or stopped, of the daily collection, the time of day that the daily collection runs, the uniform resource identifier (URI) of the aggregation server, and the certificate thumbprint to use for encryption. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-SilLogging</maml:name><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</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:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.Management.Automation.PSCustomObject</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Get settings for the current computer</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-SilLogging SIL Running State : Started SIL Time Of Day : 01/01/2013 3:00:00AM Target URI : https://log03.hosts.contoso.com Certificate Thumbprint : </dev:code><dev:remarks><maml:para>This command displays the configuration settings for Software Inventory Logging.</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=216582</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Set-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Start-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Stop-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Publish-SilData</maml:linkText><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-SilLogging</command:name><maml:description><maml:para>Applies configuration settings for Software Inventory Logging. </maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>SilLogging</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-SilLogging cmdlet applies configuration settings for Software Inventory Logging. If logging is started, Software Inventory Logging collects data daily from all Software Inventory Logging data sources, and then forwards this data over the network to an aggregation server. Specify an aggregation server by using this cmdlet. If you do not specify an aggregation server and the server is a virtual machine that runs on a Hyper-V host, then the daily collection forwards the Software Inventory Logging data to a location that its Windows Server host can access. This cmdlet sets the time of day that the daily collection occurs, the uniform resource identifier (URI) of the aggregation server, and the certificate thumbprint to use for encryption.</maml:para><maml:para>Use the Start-SilLogging cmdlet to start logging.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-SilLogging</maml:name><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TimeOfDay</maml:name><maml:description><maml:para>Specifies the time of day as a DateTime object when Software Inventory Logging forwards data. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date. The default value is 3 a.m.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-SilLogging</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CertificateThumbprint</maml:name><maml:description><maml:para>Specifies a certificate thumbprint as a string. Software Inventory Logging encrypts logging data sent to the aggregation server by using this thumbprint. If you do not specify a value for this parameter, Software Inventory Logging does not encrypt data.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetUri</maml:name><maml:description><maml:para>Specifies the URI of an aggregation server. If you do not specify a value for this parameter, Software Inventory Logging does not send logging data over the network. </maml:para><maml:para>If you do not specify an aggregation server for a virtual machine that runs on a computer that runs Hyper-V, Software Inventory Logging forwards logging data to a location that its Windows Server host can access.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TimeOfDay</maml:name><maml:description><maml:para>Specifies the time of day as a DateTime object when Software Inventory Logging forwards data. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date. The default value is 3 a.m.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CertificateThumbprint</maml:name><maml:description><maml:para>Specifies a certificate thumbprint as a string. Software Inventory Logging encrypts logging data sent to the aggregation server by using this thumbprint. If you do not specify a value for this parameter, Software Inventory Logging does not encrypt data.</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="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetUri</maml:name><maml:description><maml:para>Specifies the URI of an aggregation server. If you do not specify a value for this parameter, Software Inventory Logging does not send logging data over the network. </maml:para><maml:para>If you do not specify an aggregation server for a virtual machine that runs on a computer that runs Hyper-V, Software Inventory Logging forwards logging data to a location that its Windows Server host can access.</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="false" pipelineInput="false" position="named" aliases=""><maml:name>TimeOfDay</maml:name><maml:description><maml:para>Specifies the time of day as a DateTime object when Software Inventory Logging forwards data. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date. The default value is 3 a.m.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</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:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name> Microsoft.Management.Infrastructure.CimMethodResult#msftsil_managementtasks#SetLoggingState</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Specify an aggregation server</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-SilLogging -TargetUri "https://log03.hosts.contoso.com" </dev:code><dev:remarks><maml:para>This command specifies an aggregation server for Software Inventory Logging for the current computer. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Specify a time of day</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-SilLogging -TimeOfDay "01/01/2013 5:00:00AM" </dev:code><dev:remarks><maml:para>This command specifies the time of day that the computer forwards logging data. Note that when you specify a date in the future, Software Inventory Logging does not start logging until that date and time. If you specify a date in the past, only the time specified is relevant to the configuration setting. </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=216622</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Start-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Stop-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Publish-SilData</maml:linkText><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>Start-SilLogging</command:name><maml:description><maml:para>Starts Software Inventory Logging daily logging.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Start</command:verb><command:noun>SilLogging</command:noun><dev:version /></command:details><maml:description><maml:para>The Start-SilLogging cmdlet starts Software Inventory Logging daily logging. If logging is started, Software Inventory Logging collects data daily from all Software Inventory Logging data sources, and then forwards this data over the network to an aggregation server. Specify an aggregation server by using the Set-SilLogging cmdlet. If you do not specify an aggregation server and the server is a virtual machine that runs on a Hyper-V host, then the daily collection forwards the Software Inventory Logging data to a location that its Windows Server host can access. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Start-SilLogging</maml:name><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</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: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:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Start logging</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Start-SilLogging </dev:code><dev:remarks><maml:para>This command starts Software Inventory Logging for the current computer.</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=240181</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Stop-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Publish-SilData</maml:linkText><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>Stop-SilLogging</command:name><maml:description><maml:para>Stops Software Inventory Logging daily logging.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Stop</command:verb><command:noun>SilLogging</command:noun><dev:version /></command:details><maml:description><maml:para>The Stop-SilLogging cmdlet stops Software Inventory Logging daily logging. If logging is started, Software Inventory Logging collects data daily from all Software Inventory Logging data sources, and then forwards this data over the network to an aggregation server. Specify an aggregation server by using the Set-SilLogging cmdlet. If you do not specify an aggregation server and the server is a virtual machine that runs on a Hyper-V host, then the daily collection forwards the Software Inventory Logging data to a location that its Windows Server host can access. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Stop-SilLogging</maml:name><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</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: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:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Stop logging</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Stop-SilLogging </dev:code><dev:remarks><maml:para>This command stops Software Inventory Logging for the current computer. </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=240207</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Start-SilLogging</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Publish-SilData</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |