en-US/LenovoInfo.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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LenovoWarrantyInfo</command:name> <maml:description> <maml:para>This cmdlet is designed to retrieve the warranty information for Lenovo devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LenovoWarrantyInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet will take a supplied Lenovo serial number and product number and perform a warranty lookup using a published Lenovo REST API.</maml:para> <maml:para>This cmdlet can also take a computer name as a parameter that will in turn retrieve the serial number and model number using WMI before retrieving the warranty status.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LenovoWarrantyInfo</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The name of the computer that should be queried via WMI to retrieve its serial number for subsequent warranty lookup.</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"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential object representing the credentials that should be used when performing a WMI query of a remote computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LenovoWarrantyInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>The serial number of the Lenovo device that should be used for the query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Product</maml:name> <maml:description> <maml:para>The Lenovo product code that should be used in the warranty lookup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The name of the computer that should be queried via WMI to retrieve its serial number for subsequent warranty lookup.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential object representing the credentials that should be used when performing a WMI query of a remote computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>The serial number of the Lenovo device that should be used for the query.</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="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Product</maml:name> <maml:description> <maml:para>The Lenovo product code that should be used in the warranty lookup.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>This cmdlet uses a REST API that was found in a Lenovo Support Forum discussion.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Perform query on local machine --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-LenovoWarrantyInfo</dev:code> <dev:remarks> <maml:para>This command will query the local machine using WMI to retrieve its serial number and then query the Lenovo service to retrieve warranty information</maml:para> <maml:para /> <maml:para /> <maml:para>Get-LenovoWarrantyInfo WarrantyEndDate : 2017-08-04 ShipDate : 2014-07-23 Type : 20C0 SerialNumber : MP05SKGB WarrantyStartDate : 2014-08-05 Model : S05200 Product : 20C0S05200</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Lookup warranty information of remote computer --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code> $cred = Get-Credential Get-LenovoWarrantyInfo -ComputerName yoga1 -Credential $cred </dev:code> <dev:remarks> <maml:para>The first line creates a credential object to be used when connecting to remote computer using WMI</maml:para> <maml:para>The second line will result in a WMI query to the computer named yoga1 using the supplied credential. The WMI query will return the devices serial number and model information to supply or the warranty lookup.</maml:para> <maml:para /> <maml:para /> <maml:para> WarrantyEndDate : 2017-08-04 ShipDate : 2014-07-23 Type : 20C0 SerialNumber : MP05SKEZ WarrantyStartDate : 2014-08-05 Model : S05200 Product : 20C0S05200</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |