en-US/Lenovo.SysMgmt.LXCA.Integration.PowerShell.dll-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> <!-- Start do not translate block --> <command:name>Connect-LXCA</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Connects to the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Connect</command:verb> <command:noun>LXCA</command:noun> <!-- End do not translate block --> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-LXCA cmdlet creates a connection to the Lenovo XClarity Administrator server that can be used by other cmdlets. Use Disconnect-LXCA to disconnect from Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Connect-LXCA</maml:name> <!-- End do not translate block --> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Host</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the Lenovo XClarity Administrator server HTTPS address (IP address or host name).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Port</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Proxy</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>Credential</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a credential object that includes the credentials for logging in to the Lenovo XClarity Administrator server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>Timeout</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the number of seconds that cmdlet waits for an HTTPS response from the Lenovo XClarity Administrator server. By default, the timeout value is 600 seconds.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>SkipCertificateCheck</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If -SkipCertificateCheck is specified, the cmdlet will skip the server certificate checking.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Host</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the Lenovo XClarity Administrator server HTTPS address (IP address or host name).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Port</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>Proxy</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> <dev:type> <maml:name>WebProxy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <!-- Start do not translate block --> <maml:name>Credential</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a credential object that includes the credentials for logging in to the Lenovo XClarity Administrator server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>Timeout</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the number of seconds that cmdlet waits for an HTTPS response from the Lenovo XClarity Administrator server. By default, the timeout value is 600 seconds.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Connect-LXCA returns an LXCAConnection object that contains the information for the Lenovo XClarity Administrator server connection.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>To disconnect from the Lenovo XClarity Administrator server, use the Disconnect-LXCA cmdlet.</maml:para> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$cred = Get-Credential $connection = Connect-LXCA -Host 1.111.11.11 -Credential $cred</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This example illustrates retrieves the credentials that are then passed to this cmdlet to connect to the Lenovo XClarity Administrator server with IP address 1.111.11.11.</maml:para> <maml:para/> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <!-- Start do not translate block --> <maml:linkText>Disconnect-LXCA</maml:linkText> <maml:uri /> <!-- End do not translate block --> </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> <!-- Start do not translate block --> <command:name>Disconnect-LXCA</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Disconnects from Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Disconnect</command:verb> <command:noun>LXCA</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Disconnect-LXCA cmdlet deletes the connection to an Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Disconnect-LXCA</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Disconnect-LXCA does not return objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet /> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$cred = Get-Credential Connect-LXCA -Host 1.111.11.11 -Credential $cred #Other actions Disconnect-LXCA </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This example illustrates how to connect to the Lenovo XClarity Administrator server at IP 1.111.11.11 and then disconnect from the server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <!-- Start do not translate block --> <maml:linkText>Connect-LXCA</maml:linkText> <maml:uri /> <!-- End do not translate block --> </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> <!-- Start do not translate block --> <command:name>Get-LXCAChassis</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Retrieves information about one or more chassis that have been discovered by the Lenovo XClarity Administrator server, including managed and unmanaged chassis.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAChassis</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>This cmdlet retrieves information about one or more chassis that have been discovered by the Lenovo XClarity Administrator server, including managed and unmanaged chassis.</maml:para> <maml:para>This cmdlet returns system information (such as location, health, and machine type) about the chassis and CMMs installed in the chassis . It does not include detailed information about other chassis components (such as compute nodes, Flex switches, or fans). For inventory information for the chassis and chassis components, use the Get-LXCAChassisInventory cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAChassis</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the chassis. If no UUID is specified and you specify the -Unmanaged parameter,all unmanged chassis are returned. If no UUID is specified and the -Unmanaged parameter is not specified, this cmdlet returns all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAChassis</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Unmanaged is specified, the cmdlet returns a list of unmanaged chassis. Otherwise, the cmdlet returns a list of managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the chassis. If no UUID is specified and you specify the -Unmanaged parameter,all unmanged chassis are returned. If no UUID is specified and the -Unmanaged parameter is not specified, this cmdlet returns all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Unmanaged is specified, the cmdlet returns a list of unmanaged chassis. Otherwise, the cmdlet returns a list of managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAChassis returns a list of chassis objects that contains information about each chassis and its CMM.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$chassis = Get-LXCAChassis</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command get all managed chassis from Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCAComputeNode</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets information about one or more compute nodes from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAComputeNode</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAComputeNode cmdlet gets information about one or more compute nodes from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAComputeNode</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more chassis instances. The cmdlet returns all compute nodes in each chassis. If no chassis is specified, the cmdlet returns all compute nodes from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAComputeNode</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific chassis. The cmdlet returns all compute nodes on the specified chassis. If no chassis UUID is specified, the cmdlet returns all compute nodes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAComputeNode</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific compute node. If no compute node UUID is specified, the cmdlet returns all compute nodes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of chassis instances. The cmdlet returns all compute nodes in each chassis. If no chassis is specified, the cmdlet returns all compute nodes from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific chassis. The cmdlet returns all compute nodes on the specified chassis. If no chassis UUID is specified, the cmdlet returns all compute nodes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>NodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific compute node. If no compute node UUID is specified, the cmdlet returns all compute nodes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe Chassis objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ComputeNode[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAComputeNode returns a list of compute nodes with information about the compute node, such as firmware levels, installed processors, and installed memory.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$nodes = Get-LXCAComputeNode </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets a list of all compute nodes from all managed chassis.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAChassisInventory</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> <!-- Start do not translate block --> <command:name>Get-LXCAChassisInventory</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets inventory data about one or more chassis from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAChassisInventory</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAChassisInventory cmdlet gets inventory data about one or more compute nodes from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAChassisInventory</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of chassis. The cmdlet returns the inventory data of each chassis in the list.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAChassisInventory</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of chassis. The cmdlet returns the inventory data from the specified chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of chassis. The cmdlet returns the inventory data of each chassis in the list.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of chassis. The cmdlet returns the inventory data from the specified chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe Chassis objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ChassisInventory[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAChassisInventory returns a list of ChassisInventory objects that contains the chassis inventory data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$chassis = Get-LXCAChassis $chassisinventory = Get-LXCAChassisInventory -Chassis $chassis </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets inventory data for all managed chassis.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCAChassisMember</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the installed components (members) of one or more chassis.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAChassisMember</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAChassisMember cmdlet gets the installed components (members) of one or more chassis, including compute nodes, storage nodes, fans, fan logic modules, power supplies and I/O modules (Pass-thru modules and switches).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAChassisMember</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of chassis. This cmdlet returns information about chassis members for each chassis in the list. If no chassis is specified, all members of all chassis will be returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAChassisMember</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific chassis. The cmdlet returns the components of the specified chassis. If no chassis is specified, all components of all chassis are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAChassisMember</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MemberUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific component. The cmdlet returns the component with the specified UUID. If no UUID is specified, all components of all chassis are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of chassis. The cmdlet returns information about chassis members for each chassis in the list. If no chassis is specified, all members of all chassis will be returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific chassis. The cmdlet returns the components of the specified chassis. If no chassis is specified, all components of all chassis are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MemberUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific component. The cmdlet returns the component with the specified UUID. If no UUID is specified, all components of all chassis are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe Chassis objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ChassisMember[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAChassisMember returns a list of ChassisMember objects that contain information about each of the installed components.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$chassis = Get-LXCAChassis $chassmember = Get-LXCAChassisMember -Chassis $chassis[0] </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command get all components of a specified chassis.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCAOSImage</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the operating system images in the Lenovo XClarity Administrator server image repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAOSImage cmdlet gets the operating system images in the Lenovo XClarity Administrator server image repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAOSImage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the operating system image ID. If no image ID is specified, all images on server repository are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the operating system image ID. If no image ID is specified, all images on server repository are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.OSImage[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAOSImage returns a list of OSImage objects with image information.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$images = Get-LXCAOSImage </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command get all OS images on the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Remove-LXCAOSImage</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Removes an operating system image from the Lenovo XClarity Administrator server image repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Remove</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Remove-LXCAOSImage cmdlet removes an operating system images and its image profiles from the Lenovo XClarity Administrator server image repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAOSImage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the image ID. The cmdlet removes the operating system image and its image profiles.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet removes the image or profile without first prompting for confirmation about the removal.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAOSImage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>OSImage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the operating system image. The cmdlet removes the image and its image profiles.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">OSImage</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet removes the image or profile without first prompting for confirmation about the removal.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAOSImage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the image profile ID. The cmdlet removes the image profile from the image repository.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet removes the image or profile without first prompting for confirmation about the removal.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the image ID. The cmdlet removes the operating system image and its image profiles.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>OSImage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the operating system image. The cmdlet removes the image and its image profiles.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">OSImage</command:parameterValue> <dev:type> <maml:name>OSImage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the image profile ID. The cmdlet removes the image profile from the image repository.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet removes the image or profile without first prompting for confirmation about the removal.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.OSImage</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe OSImage to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCAOSImage does not return objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$images = Get-LXCAOSImage Remove-LXCAOSImage -OSImage $images[0] </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command removes an OS image from the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-LXCAOSImage</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> <!-- Start do not translate block --> <command:name>Set-LXCADeployGlobalSetting</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Sets the global settings used for operating system deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Set</command:verb> <command:noun>LXCADeployGlobalSetting</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Set-LXCADeployGlobalSetting cmdlet sets the global settings used for operating system deployment, such as IP assignment type and deployment credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCADeployGlobalSetting</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DeployGlobalSetting</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the global deploy settings which includes IP assignment type and deploy credentials.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">DeployGlobalSetting</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DeployGlobalSetting</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the global deploy setting which includes IP assignment type and deploy credentials.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">DeployGlobalSetting</command:parameterValue> <dev:type> <maml:name>DeployGlobalSetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCADeployGlobalSetting does not return objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$setting = Get-LXCADeployGlobalSetting $setting.IpAssignment = "dhcpv4" # staticv4 / dhcpv4 Set-LXCADeployGlobalSetting -DeployGlobalSetting $setting </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command updates the global deploy settings.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCADeployGlobalSetting</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> <!-- Start do not translate block --> <command:name>Get-LXCAStorageNode</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets information about one or more storage nodes from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAStorageNode</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAStorageNode cmdlet gets information about one or more storage nodes from the xLenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAStorageNode</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more chassis. The cmdlet returns all storage nodes from each chassis in the list. If no chassis is specified, the cmdlet returns all storage nodes from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAStorageNode</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more chassis UUIDs. The cmdlet returns all storage nodes on the specified chassis. If no chassis UUID is specified, the cmdlet returns all storage nodes from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAStorageNode</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific storage node. If no storage node UUID is specified, all storage nodes will be returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more chassis. The cmdlet returns all storage nodes from each chassis in the list. If no chassis is specified, the cmdlet returns all storage nodes from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more chassis UUIDs. The cmdlet returns all storage nodes on the specified chassis. If no chassis UUID is specified, the cmdlet returns all storage nodes from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific storage node. If no storage node UUID is specified, all storage nodes will be returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe the Chassis object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.StorageNode</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAStorageNode returns StorageNode objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$nodes = Get-LXCAStorageNode </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the storage nodes installed in all chassis that have been discovered.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAUserAccount</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets information for all user accounts from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAUserAccount cmdlet gets information about all user accounts from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAUserAccount</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAUserAccount returns UserAccount objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$accounts = Get-LXCAUserAccount </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the user accounts.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Remove-LXCAUserAccount</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Deletes a user account from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Remove</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Remove-LXCAUserAccount cmdlet removes a user account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAUserAccount</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserAccount</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account to be deleted.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Removes the user account without first prompting for confirmation about the removal.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserAccount</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account to be deleted.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> <dev:type> <maml:name>UserAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Removes the user account without first prompting for confirmation about the removal.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe the UserAccount object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCAUserAccount does not return object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$account = Get-LXCAUserAccount | where { $_.UserName -eq "testuser" } Remove-LXCAUserAccount -UserAccount $account -Force </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command removes a user account with name "testuser".</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-LXCAUserAccount</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> <!-- Start do not translate block --> <command:name>Set-LXCAUserAccountPassword</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Modifies the password for an existing user account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Set</command:verb> <command:noun>LXCAUserAccountPassword</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Set-LXCAUserAccountPassword cmdlet modifies the password for an existing user account on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCAUserAccountPassword</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the current password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NewPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the new password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ConfirmPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Confirms the new password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCAUserAccountPassword</maml:name> <!-- End do not translate block --> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Host</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the Lenovo XClarity Administrator server HTTPS address (IP address or host name).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Port</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Proxy</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user ID of the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the current password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NewPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the new password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ConfirmPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Confirm the new password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Host</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the HTTPS address (IP address or host name) of the Lenovo XClarity Administrator server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Port</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>Proxy</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> <dev:type> <maml:name>WebProxy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user ID of the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the current password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NewPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the new password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ConfirmPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Confirm the new password.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCAUserAccountPassword does not return objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$cred = Get-Credential Connect-LXCA -Host 9.125.90.21 -Port 443 -Credential $cred $Password = ConvertTo-SecureString "curpwd" -AsPlainText –Force $NewPassword = ConvertTo-SecureString "newpwd" -AsPlainText –Force $ConfirmPassword = ConvertTo-SecureString "newpwd" -AsPlainText –Force Set-LXCAUserAccountPassword -CurrentPassword $Password -NewPassword $NewPassword -ConfirmPassword $ConfirmPassword </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command modifies the password for a currently authenticated user.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$Password = ConvertTo-SecureString "curpwd" -AsPlainText –Force $NewPassword = ConvertTo-SecureString "newpwd" -AsPlainText –Force $ConfirmPassword = ConvertTo-SecureString "newpwd" -AsPlainText –Force Set-LXCAUserAccountPassword -Host 9.125.90.21 -UserName "userid" -CurrentPassword $Password -NewPassword $NewPassword -ConfirmPassword $ConfirmPassword </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command modify the password for an unauthenticated user.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAActiveAlert</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets active alerts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAActiveAlert</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAActiveAlert cmdlet gets active alerts from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAActiveAlert</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComponentID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which alerts apply.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAActiveAlert</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the alert severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComponentID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which alerts apply.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ActiveAlert[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAActiveAlert returns ActiveAlert objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$alerts = Get-LXCAActiveAlert </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all active alerts from the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$alerts = Get-LXCAActiveAlert -Severity Critical,Fatal -EventClass Blade </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the critical and fatal active alerts for a compute node.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAAuditLog</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the audit log from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAAuditLog</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAAuditLog cmdlet gets the audit log from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAAuditLog</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more audit event IDs. If you do not specify an event ID, all events are returned. Tip: You can use the Get-LXCAAuditLog cmdlet to retrieve a list of audit event IDs.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PreviousHours</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining log entries.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StartSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EndSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more audit event IDs. If you do not specify an event ID, all events are returned. Tip: You can use the Get-LXCAAuditLog cmdlet to retrieve a list of audit event IDs.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PreviousHours</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining log entries.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StartSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EndSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.AuditLog[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAAuditLog returns AuditLog objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$audit = Get-LXCAAuditLog </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets the entire audit log.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$audit = Get-LXCAAuditLog -Severity Critical,Fatal -PreviousHours 12 </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the critical and fatal audit log entries that have occurred in the last 12 hours.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAActiveStatus</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the current status for a managed endpoint.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAActiveStatus</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAActiveStatus cmdlet gets the current status for one or more endpoints being managed by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAActiveStatus</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComponentID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which the status applies.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAActiveStatus</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity. Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma. The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComponentID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which the status applies.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity. Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma. The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ActiveStatus[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAActiveStatus returns ActiveStatus objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$status = Get-LXCAActiveStatus </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets the current status for all managed endpoints.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$status = Get-LXCAActiveStatus -Severity Critical,Fatal </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets the list of endpoints that have a status with a severity of critical or fatal.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAFFDCFile</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the FFDC file from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAFFDCFile</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAFFDCFile cmdlet downloads the First Failure Data Capture (FFDC) file to the local system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAFFDCFile</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Destination</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the local directory and file name where the file is to be saved. The file is saved as a ZIP file that contains all selected diagnostic files (.TAR.GZ archive files). If only a directory is specified, the cmdlet saves the FFDC file using the file name that is retuned from the Lenovo XClarity Administrator server. If a directory and a file name are specified, the cmdlet saves the FFDC file using the specified file name. Note: The specified directory must already exist.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Overwrite</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to overwrite the local file when a file with that same name exists already.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Destination</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the local directory and file name where the file is to be saved. The file is saved as a ZIP file that contains all selected diagnostic files (.TAR.GZ archive files). If only a directory is specified, the cmdlet saves the FFDC file using the file name that is retuned from the Lenovo XClarity Administrator server. If a directory and a file name are specified, the cmdlet saves the FFDC file using the specified file name. Note: The specified directory must already exist.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Overwrite</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to overwrite the local file when a file with that same name exists already.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>String</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAFFDCFile returns the FFDC file path on the local system.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Get-LXCAFFDCFile -Destination C:\LXCA\ -Overwrite </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command downloads the FFDC file and saves it under the directory C:\LXCA\. If the file with same name already exists, the old one will be replaced.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Get-LXCAFFDCFile -Destination C:\LXCA\myFFDC.zip </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command downloads the FFDC file and saves it to C:\LXCA\myFFDC.zip.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAConfigPatternDeployableServer</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets a list of deployable servers and compute node bays that meet the criteria for a server pattern or profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAConfigPatternDeployableServer</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAConfigPatternDeployableServer cmdlet returns a list of deployable servers and compute node bays that meet the criteria for a server pattern or profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAConfigPatternDeployableServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server pattern ID. You can obtain a list of all server pattern IDs using the Get-LXCAConfigPattern cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAConfigPatternDeployableServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server profile ID. You can obtain a list of all server profile IDs using the Get-LXCAConfigProfile cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server Pattern ID. You can obtain a list of all server pattern IDs using the Get-LXCAConfigPattern cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server profile ID. You can obtain a list of all server profile IDs using the Get-LXCAConfigProfile cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>LXCAConfigPatternDeployableTarget</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAConfigPatternDeployableServer returns LXCAConfigPatternDeployableTarget objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$patterns = Get-LXCAConfigPattern $chassis = Get-LXCAConfigPatternDeployableServer -PatternId $patterns[0].Id $chassis[0].Servers </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets the deployable servers according to a server pattern.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAConfigPattern</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> <!-- Start do not translate block --> <command:name>Remove-LXCAConfigProfileFromSystem</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Removes a server profile from assignment to an associated system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Remove</command:verb> <command:noun>LXCAConfigProfileFromSystem</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Remove-LXCAConfigProfileFromSystem cmdlet removes a server profile from assignment to the associated system. The server profile is still available on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAConfigProfileFromSystem</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Profile</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server profile object.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">ConfigProfile</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAConfigProfileFromSystem</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server profile ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Profile</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server profile object.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">ConfigProfile</command:parameterValue> <dev:type> <maml:name>ConfigProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Server profile ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>ConfigProfile</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe the ConfigProfile object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>No</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAConfigPatternDeployableServer does not return any object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$profiles = Get-LXCAConfigProfile | where{$_.status -eq "ASSIGNED"} Remove-LXCAConfigProfileFromSystem -ProfileId $profiles[0].Id </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command removes the server profile from assignment to the associated system.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAConfigProfile</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> <!-- Start do not translate block --> <command:name>Get-LXCAConfigProfile</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets one or more server profiles from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAConfigProfile</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAConfigProfile cmdlet gets one or more server profiles from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAConfigProfile</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the profile ID. If no profile ID is specified, all server profiles are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAConfigProfile</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the pattern ID. If the pattern ID is specified, all server profiles for this pattern are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the profile ID. If no profile ID is specified, all server profiles are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the pattern ID. If the pattern ID is specified, all server profiles for this pattern are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigProfile[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAConfigProfile returns a list of configuration profile objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$profiles = Get-LXCAConfigProfile</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all configuration profiles from the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAConfigPattern</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> <!-- Start do not translate block --> <command:name>Get-LXCAIOModule</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets information about one or more I/O modules from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAIOModule</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAIOModule cmdlet gets information about one or more I/O modules from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAIOModule</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more chassis instances. The cmdlet returns all I/O modules in each chassis. If no chassis is specified, the cmdlet returns all I/O modules from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAIOModule</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific chassis. The cmdlet returns all I/O modules on the specified chassis. If no chassis UUID is specified, the cmdlet returns all I/O modules from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAIOModule</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IOModuleUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific I/O module. If no I/O module UUID is specified, the cmdlet returns all I/O modules.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Chassis</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of chassis instances. The cmdlet returns all I/O modules in each chassis. If no chassis is specified, the cmdlet returns all I/O modules from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific chassis. The cmdlet returns all IO modules on the specified chassis. If no chassis UUID is specified, the cmdlet returns all IO modules from all managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>IOModuleUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a specific IO module. If no IO module UUID is specified, the cmdlet returns all IO modules.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe Chassis objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.IOModule[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAComputeNode returns a list of IO modules.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$iomodules = Get-LXCAIOModule -ChassisUuid 1B33D6CE9FFD410158210817F476E900</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets a list of all IO modules from a specified chassis.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCASystemCompliance</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets system compliance information from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCASystemCompliance</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCASystemCompliance cmdlet gets firmware compliance information about one or more endpoints from the Lenovo XClarity Administrator server, including CMMs, Flex switch, Flex System compute nodes, or System x servers, to which a compliance policy has been assigned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCASystemCompliance</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the target system. The target system can be a chassis, CMM, Flex switch, Flex System compute node, or System x server. If you specify a chassis, information for endpoints installed in the chassis are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the type of the target system. The type can be Chassis, CMM, Flex switch, Flex System compute node, or System x server.</maml:para> <maml:para>- Chassis. Target system (specified by UUID) is a chassis. The compliance information for the CMM, Flex switch, and Flex System computes nodes installed in the chassis will be returned.</maml:para> <maml:para>- CMM. Target system (specified by UUID) is a CMM.</maml:para> <maml:para>- IOSwitch. Target system (specified by UUID) is Flex switch.</maml:para> <maml:para>- ComputeNode. Target system (specified by UUID) is a Flex System compute node.</maml:para> <maml:para>- RackServer. Target system (specified by UUID) is a System x server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the target system. The target system can be a chassis, CMM, Flex switch, Flex System compute node, or System x server. If you specify a chassis, information for endpoints installed in the chassis are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>SystemType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the type of the target system. The type can be Chassis, CMM, Flex switch, Flex System compute node, or System x server.</maml:para> <maml:para>- Chassis. Target system (specified by UUID) is a chassis. The compliance information for the CMM, Flex switch, and Flex System computes nodes installed in the chassis will be returned.</maml:para> <maml:para>- CMM. Target system (specified by UUID) is a CMM.</maml:para> <maml:para>- IOSwitch. Target system (specified by UUID) is Flex switch.</maml:para> <maml:para>- ComputeNode. Target system (specified by UUID) is a Flex System compute node.</maml:para> <maml:para>- RackServer. Target system (specified by UUID) is a System x server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <dev:type> <maml:name>SystemType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.SystemCompliance[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCASystemCompliance returns a list of system compliance objects that contains firmware compliance information.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$compliance = Get-LXCASystemCompliance -SystemUuid 2B885CEB5B6711E1A12B5CF3FC11314A -SystemType Chassis</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets the system compliance information of one chassis, including the CMM, Flex switch, and Flex System compute nodes.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Install-LXCAOSImage</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Deploys an OS image to one or more target systems (endpoints).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Install</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Install-LXCAOSImage cmdlet deploys an operating system image to one or more target systems (endpoints).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Install-LXCAOSImage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DeployTask</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of deployment tasks. The list is created by the New-LXCADeployTask cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">DeployTask[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DeployTask</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of deployment tasks. The list is created from the New-LXCADeployTask cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">DeployTask[]</command:parameterValue> <dev:type> <maml:name>DeployTask[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployResult[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAOSImage returns a list Data.DeployResult objects when the AsJob parameter is not used.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAOSImage returns a job object when the AsJob parameter is used. The DeployResult[] can be retrieved from Job.Output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$nodes = Get-LXCADeployableServer $images = Get-LXCAOSImage | where {$_.Name -like "*esxi5.5*"} $deployTask = New-LXCADeployTask -ServerUuid $nodes[0].Uuid -ImageProfileID $images[0].Profiles[0].Id -TargetDevice "SanDisk" -SanId "WWN123445" -MacAddress $nodes[0].HostMacAddresses[0] -IpAddress 9.5.12.122 -SubnetMask 255.255.255.0 -GateWay 9.5.12.1 -DNS1 9.10.244.100 -DNS2 9.10.244.200 -Mtu 1500 Install-LXCAOSImage -DeployTask $deployTask </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command installs an ESXi 5.5 OS image on a target system in synchronous mode.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$nodes = Get-LXCADeployableServer $esxi5 = Get-LXCAOSImage | where { $_.Name -like "*esxi5.5*" } $rhel6 = Get-LXCAOSImage | where { $_.Name -like "*RHEL6*" } #create deploy node list $deployList = @() $deployTask = New-LXCADeployTask -ServerUuid $nodes[0].Uuid -ImageProfileID $esxi5.Profiles[0].Id -TargetDevice "SanDisk" -SanId "WWN123445" -MacAddress $nodes[0].HostMacAddresses[0] -IpAddress 9.5.12.122 -SubnetMask 255.255.255.0 -GateWay 9.5.12.1 -DNS1 9.10.244.100 -DNS2 9.10.244.200 -Mtu 1500 $deployList.Add($deployTask); $deployTask = New-LXCADeployTask -ServerUuid $nodes[1].Uuid -ImageProfileID $rhel6.Profiles[0].Id -TargetDevice "LocalDisk" -MacAddress $nodes[1].HostMacAddresses[0] -IpAddress 9.5.12.123 -SubnetMask 255.255.255.0 -GateWay 9.5.12.1 -DNS1 9.10.244.100 -DNS2 9.10.244.200 -Mtu 1500 $deployList.Add($deployTask); #deploy node $job = Install-LXCAOSImage -DeployTask $deployList -AsJob while ($job.State eq "Running") { Start-Sleep -Seconds 5 } $job.Output </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command deploys multiple OS images to multiple target systems in asynchronous mode.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-LXCADeployTask</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> <!-- Start do not translate block --> <command:name>Get-LXCAJob</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets one or more jobs from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAJob</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAJob cmdlet gets one or more jobs from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAJob</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>JobID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the job ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAJob</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the component to which the job belongs.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Category</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the job category.</maml:para> <maml:para>The category values are Management, Configuration, Firmware, Health, Power, RemoteAccess, SystemId, and Custom. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>State</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the job state.</maml:para> <maml:para>The job state values are Pending, Running, Complete, Cancelled, RunningWithErrors, CancelledWithErrors, and StoppedWithError. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>JobID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the job ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the component to which the job belongs.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Category</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the job category.</maml:para> <maml:para>The category values are Management, Configuration, Firmware, Health, Power, RemoteAccess, SystemId, and Custom. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>State</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the job state.</maml:para> <maml:para>The job state values are Pending, Running, Complete, Cancelled, RunningWithErrors, CancelledWithErrors, and StoppedWithError. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Job[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAJob returns Job objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$jobs = Get-LXCAJob -State Running,RunningWithErrors </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the jobs from the Lenovo XClarity Administrator server that are currently running.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Stop-LXCAJob</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Cancels one job on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Stop</command:verb> <command:noun>LXCAJob</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Stop-LXCAJob cmdlet cancels one running or pending job on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Stop-LXCAJob</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>JobID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Stop-LXCAJob</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Job</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job instance.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Job</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>JobID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Job</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job instance.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Job</command:parameterValue> <dev:type> <maml:name>Job</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Stop-LXCAJob does not return object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$jobs = Get-LXCAJob -State Running,Pending Foreach($job in $jobs) { Stop-LXCAJob -Job $job } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command cancels all the running or pending jobs.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Remove-LXCAJob</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Deletes one job on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Remove</command:verb> <command:noun>LXCAJob</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Remove-LXCAJob cmdlet deletes one job on the Lenovo XClarity Administrator server. The job must be in a stopped, cancelled, or complete state before it can be removed. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAJob</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>JobID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAJob</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Job</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job instance.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Job</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>JobID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Job</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one job instance.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Job</command:parameterValue> <dev:type> <maml:name>Job</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCAJob does not return object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$jobs = Get-LXCAJob -State Complete,Cancelled,"Cancelled With Errors","Stopped With Error" Foreach($job in $jobs) { Remove-LXCAJob -Job $job } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command deletes all jobs that are not currently running.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Set-LXCAPSLogLevel</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Sets the log level of the PowerShell cmdlets for the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Set</command:verb> <command:noun>LXCAPSLogLevel</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Set-LXCAPSLogLevel cmdlet sets the log level of the PowerShell cmdlets for the Lenovo XClarity Administrator server. The default log level is info.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCAPSLogLevel</maml:name> <!-- End do not translate block --> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>LogLevel</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the log level of the PowerShell cmdlets for Lenovo XClarity Administrator server.</maml:para> <maml:para>The values of log level are Error, Warn, Info, and Debug.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>LogLevel</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the log level of the PowerShell cmdlets for Lenovo XClarity Administrator server.</maml:para> <maml:para>The values of log level are Error, Warn, Info, and Debug.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCAPSLogLevel does not return object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Set-LXCAPSLogLevel -LogLevel Debug </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command sets the PowerShell cmdlets log level to debug.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAActiveSession</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets currently active user sessions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAActiveSession</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAActiveSession cmdlet returns a list of currently active user sessions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAActiveSession</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ActiveSession[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAActiveSession returns a list of ActiveSession objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$sessions = Get-LXCAActiveSession </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns a list of currently active sessions.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Import-LXCAUpdatePackage</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Imports one or more local update packages to the Lenovo XClarity Administrator server firmware repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Import</command:verb> <command:noun>LXCAUpdatePackage</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Import-LXCAUpdatePackage cmdlet imports one or more local update packages to the Lenovo XClarity Administrator server firmware repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Import-LXCAUpdatePackage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>File</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the update file to be imported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Import-LXCAUpdatePackage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Folder</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the folder containing update files. Files must be in the specified folder; they cannot be in child folders.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FixId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the update Fix IDs in the folder which will be imported to the Lenovo XClarity Administrator server. If no Fix ID is specified, all available update files will be imported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>File</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the update file to be imported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Folder</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the folder containing update files. Files must be in the specified folder; they cannot be in child folders.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FixId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the update Fix IDs in the folder which will be imported to Lenovo XClarity Administrator server. If no Fix ID is specified, all available update files will be imported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the AsJob parameter, Import-LXCAUpdatePackage returns a job object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Import-LXCAUpdatePackage -File c:\Lenovo_fw_bmc_gfbt60a_windows_i386.exe,c:\Lenovo_fw_bmc_gfbt60a_windows_i386.xml </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command imports update file c:\Lenovo_fw_bmc_gfbt60a_windows_i386.exe,c:\Lenovo_fw_bmc_gfbt60a_windows_i386.xml to Lenovo XClarity Administrator server in synchronous mode.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$job = Import-LXCAUpdatePackage -Folder c:\updates -AsJob while ($job.State -eq "Running") { Start-Sleep -Seconds 5 } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command imports all update files under c:\updates to the Lenovo XClarity Administrator server in asynchronous mode.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAAvailableMachineType</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets all available machine types that are supported by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAAvailableMachineType</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAAvailableMachineType cmdlet gets all available machine types that are supported by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAAvailableMachineType</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.MachineType[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAAvailableMachineType returns a list of MachineType objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$mts = Get-LXCAAvailableMachineType </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all available machine types.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAUpdatePackage</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Returns a list of update packages from the Lenovo XClarity Administrator server firmware repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAUpdatePackage</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAUpdatePackage cmdlet returns a list of update packages from the Lenovo XClarity Administrator server firmware repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAUpdatePackage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MachineType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more machine types. If no machine type is specified, update packages for all machine types will be returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MachineType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more machine types. If no machine type is specified, update packages for all machine types will be returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UpdatePackage[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAUpdatePackage returns a list of UpdatePackage objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$packages = Get-LXCAUpdatePackage </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns a list of update packages for all available machine types from the Lenovo XClarity Administrator server firmware repository.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$packages = Get-LXCAUpdatePackage -MachineType 7893,8724 </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns a list of update packages for machine types (7893,8724) from the Lenovo XClarity Administrator server firmware repository.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Join-LXCAUpdateCompliancePolicy</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Assigns a firmware-compliance policy to a specified endpoint (CMM, Flex switch, Flex System compute node, or System x server).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Join</command:verb> <command:noun>LXCAUpdateCompliancePolicy</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Join-LXCAUpdateCompliancePolicy cmdlet assigns a firmware-compliance policy to a specified endpoint (CMM, Flex switch, Flex System compute node, or System x server).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Join-LXCAUpdateCompliancePolicy</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Policy</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the update compliance policy.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">CompliancePolicy</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the type of the target system. The type can be CMM, Flex switch, Flex System compute node, or System x server. - CMM. Target system (specified by SystemUuid) is a CMM. - IOSwitch. Target system (specified by SystemUuid) is an Flex switch. - ComputeNode. Target system (specified by SystemUuid) is a Flex System compute node. - RackServer. Target system (specified by SystemUuid) is a System x server. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Join-LXCAUpdateCompliancePolicy</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PolicyName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the update compliance policy.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the type of the target system. The type can be CMM, Flex switch, Flex System compute node, or System x server. - CMM. Target system (specified by SystemUuid) is a CMM. - IOSwitch. Target system (specified by SystemUuid) is an Flex switch. - ComputeNode. Target system (specified by SystemUuid) is a Flex System compute node. - RackServer. Target system (specified by SystemUuid) is a System x server. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Policy</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the update compliance policy.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">CompliancePolicy</command:parameterValue> <dev:type> <maml:name>CompliancePolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PolicyName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of update compliance policy.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the type of the target system. The type can be CMM, Flex switch, Flex System compute node, or System x server. - CMM. Target system (specified by SystemUuid) is a CMM. - IOSwitch. Target system (specified by SystemUuid) is an Flex switch. - ComputeNode. Target system (specified by SystemUuid) is a Flex System compute node. - RackServer. Target system (specified by SystemUuid) is a System x server. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <dev:type> <maml:name>SystemType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.SystemCompliance</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Join-LXCAUpdateCompliancePolicy returns a SystemCompliance object on the target system.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$policy= Get-LXCAUpdateCompliancePolicy $complianceResult = Join-LXCAUpdateCompliancePolicy -Policy $policy[0] -SystemUuid 2B885CEB5B6711E1A12B5CF3FC11314A -SystemType ComputeNode</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets an update compliance policy and assigns it to a compute node with UUID 2B885CEB5B6711E1A12B5CF3FC11314A.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCAConnection</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets all available PowerShell connections with the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAConnection</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAConnection cmdlet gets all available PowerShell connections with the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe any object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAConnection returns a list of LXCAConnection objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$connections = Get-LXCAConnection foreach ($conn in $connections) { Disconnect-LXCA -Connection $conn } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This example gets all available connections and disconnects them from the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCARackServer</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets information about one or more rack servers from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCARackServer</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCARackServer cmdlet gets information about one or more rack servers from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCARackServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Unmanaged is specified, the cmdlet returns a list of unmanaged rack servers. By default, the cmdlet returns a list of managed rack servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCARackServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of System x servers. If no rack server UUID is specified, the cmdlet returns all managed rack servers unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all System x servers that are not currently managed. If not specified, this cmdlet returns all managed System x servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of System x servers. If no rack server UUID is specified, the cmdlet returns all managed rack servers unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all System x servers that are not currently managed. If not specified, this cmdlet returns all managed System x servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe any object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackServer[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCARackServer returns a list of System x servers.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$rackservers = Get-LXCARackServer</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns a list of all managed System x servers.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCAServiceFile</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the service First Failure Data Capture (FFDC) file that the Lenovo XClarity Administrator server has collected from a specified endpoint.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAServiceFile</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAServiceFile cmdlet gets the service First Failure Data Capture (FFDC) file of a specified endpoint and saves it to the local system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAServiceFile</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of endpoints.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Destination</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the local path where the file is to be saved. The file is downloaded in a single .TAR.GZ archive file. If a directory is specified, the cmdlet saves the FFDC file to a file using the file name that is retuned from the Lenovo XClarity Administrator server. If a directory and a file name are specified, the cmdlet saves the FFDC file using the specified file name. Note: The full specified path must already exist.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Overwrite</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to overwrite the local file if a file with that name exists already.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAServiceFile</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>All</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Download service FFDC file for all endpoints.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Destination</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the local path where the file is to be saved. The file is downloaded in a single .TAR.GZ archive file. If a directory is specified, the cmdlet saves the FFDC file to a file using the file name that is retuned from the Lenovo XClarity Administrator server. If a directory and a file name are specified, the cmdlet saves the FFDC file using the specified file name. Note: The full specified path must already exist.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Overwrite</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to overwrite the local file if a file with that name exists already.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of endpoints.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>All</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Download service FFDC file for all endpoints.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Destination</maml:name> <!-- End do not translate block --> <maml:description> <maml:para><maml:para>Specifies the local path where the file is to be saved. The file is downloaded in a single .TAR.GZ archive file. If a directory is specified, the cmdlet saves the FFDC file to a file using the file name that is retuned from the Lenovo XClarity Administrator server. If a directory and a file name are specified, the cmdlet saves the FFDC file using the specified file name. Note: The full specified path must already exist.</maml:para></maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Overwrite</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to overwrite the local file if a file with that name exists already.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>String</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAServiceFile returns the FFDC file path on the local system.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Get-LXCAFServiceFile -Uuid AAAAAAAAAAAAAAAA -Destination C:\LXCA\ -Overwrite </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command downloads the service FFDC file of endpoint AAAAAAAAAAAAAAAA and saves it under the directory C:\LXCA\. If the file with same name already exists, the old one will be replaced.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Get-LXCAServiceFile -All -Destination C:\LXCA\myFFDC.zip </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command downloads the service FFDC file of all endpoints and saves it to C:\LXCA\myFFDC.zip.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Start-LXCAEventMonitor</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Creates an event monitor object that can be subscribed to by the cmdlet Register-ObjectEvent. It allows an administrator to monitor specific Lenovo XClarity Administrator events and trigger a defined script to handle the incoming event.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Start</command:verb> <command:noun>LXCAEventMonitor</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Start-LXCAEventMonitor cmdlet creates an event monitor object that can be subscribed to by the cmdlet Register-ObjectEvent. It allows an administrator to monitor specific Lenovo XClarity Administrator events and trigger a defined script to handle the incoming event. It will re-connect to Lenovo XClarity Administrator when the network is not available or the management server is rebooted, and to continue monitoring events.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Start-LXCAEventMonitor</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event IDs that will be monitored.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MessageRegex</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event message regex expression.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event IDs that will be monitored.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MessageRegex</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event message regex expression.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAEventMonitor</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Start-LXCAEventMonitor returns LXCAEventMonitor object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$monitor = Start-LXCAEventMonitor -EventClass Audit,Power -Severity Critical,Fatal Register-ObjectEvent -InputObject $monitor -EventName LXCAEvent -SourceIdentifier MonitorAUDITPOWER -Action { Write-Host $EventArgs.Events[0].EventID -ForegroundColor Blue Write-Host $EventArgs.Events[0].Message -ForegroundColor Blue } ... ... $monitor.StopMonitor() </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This example shows how to create an event monitor and use Register-ObjectEvent to print out the event ID and message when a monitored event is received.</maml:para> <maml:para>In cmdlet Register-ObjectEvent, the -EventName must be LXCAEvent, -SourceIdentifier should be an unique string, -Action is the script which will handle the incoming event. In the script, $EventArgs.Events is for all incoming events at this moment. Each event has the same properties as the event returned by cmdlet Get-LXCAEvent.</maml:para> <maml:para>To stop the event monitoring, invoke "$monitor.StopMonitor()".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Register-ObjectEvent</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> <!-- Start do not translate block --> <command:name>Backup-LXCAEventLog</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the event log in CSV format and appends it to a local file. You can use this cmdlet to back up the event log periodically to avoid event log loss.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Backup</command:verb> <command:noun>LXCAEventLog</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Backup-LXCAEventLog cmdlet gets the event log in CSV format and appends it to local file. Normally this cmdlet can be used to back up the event log periodically, which can avoid the event log loss.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Backup-LXCAEventLog</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Type</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event type. Available values are All, EventLog, and AuditLog.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StartSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the starting event sequence number.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Count</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the number of events that are to be returned from the starting sequence number.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FileName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the file name to which the events is to be appended.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NoHead</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet is not saves the CSV header to the local file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Type</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event type. Available values are All, EventLog, and AuditLog.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StartSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the starting event sequence number.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Count</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the number of events that are to be returned from the starting sequence number.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FileName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the file name to which the events is to be appended.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NoHead</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet is not saves the CSV header to the local file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.BackupEventResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para>BackupEventResult has a property "NextSequenceNumber" that indicates the starting sequence number that can be used for the next backup.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Backup-LXCAEventLog returns BackupEventResult object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$backupResult = Backup-LXCAEventLog -Type All -StartSequenceNumber 0 -Count 1000 -FileName c:\LXCALog.csv While($true) { Start-Sleep -Seconds (60*60*1) $backupResult = Backup-LXCAEventLog -Type All -StartSequenceNumber $backupResult.NextSequenceNumber -Count 1000 -FileName c:\LXCALog.csv -NoHead } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This example shows how to backup the event log to a local file every hour.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Add-LXCAEventExclusionFilter</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Adds an event exclusion filter to exclude an event or active alert from target endpoint.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Add</command:verb> <command:noun>LXCAEventExclusionFilter</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Add-LXCAEventExclusionFilter cmdlet adds an event exclusion filter to exclude the event or active alert from target endpoint. Excluded events are not be returned by the Get-LXCAEvent cmdlet. Use the Get-LXCAEventExclusionFilter cmdlet to get the exclusion filter. Use the Add-LXCAEventExclusionFilter and Remove-LXCAEventExclusionFilter cmdlets to add and remove the exclusion filter. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAEventExclusionFilter</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Name</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the exclusion filter. The name must be unique.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description of the exclusion filter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of target endpoint.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Type</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event type. Available values are event and activeAlert.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Name</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the exclusion filter. The name must be unique.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description of the exclusion filter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of target endpoint.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Type</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event type. Available values are event and activeAlert.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.EventExclusionFilter</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para/> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAEventExclusionFilter returns EventExclusionFilter object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Add-LXCAEventExclusionFilter -SourceID AAAAAAAAAAAA -Name "ExclusionFilterOnAAAAAAAAAAAA" -Description "Suppress events from AAAAAAAAAAAA" -Type event </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command excludes all event from system AAAAAAAAAAAA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAEventExclusionFilter</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets information about one or more event exclusion filters.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAEventExclusionFilter</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAEventExclusionFilter cmdlet gets information about one or more event exclusion filters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAEventExclusionFilter</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FilterID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the ID of the exclusion filter. If no ID is specified, the cmdlet will return all exclusion filters.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAEventExclusionFilter</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of target system. If no UUID is specified, the cmdlet will return all exclusion filters.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FilterID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the ID of the exclusion filter. If no ID is specified, the cmdlet will return all exclusion filters.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of target system. If no UUID is specified, the cmdlet will return all exclusion filters.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.EventExclusionFilter[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para/> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAEventExclusionFilter returns EventExclusionFilter objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Get-LXCAEventExclusionFilter -SourceID AAAAAAAAAAAA </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command get all event exclusion filters from system AAAAAAAAAAAA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Remove-LXCAEventExclusionFilter</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Deletes an event exclusion filter.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Remove</command:verb> <command:noun>LXCAEventExclusionFilter</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Remove-LXCAEventExclusionFilter cmdlet deletes an event exclusion filter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAEventExclusionFilter</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FilterID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the ID of the exclusion filter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FilterID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the ID of the exclusion filter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para/> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCAEventExclusionFilter does not return any object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Remove-LXCAEventExclusionFilter -FilterID "AUG:XFT:1" </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command deletes event exclusion filter "AUG:XFT:1".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCADeployableServer</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets a list of servers that are ready for operating system deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCADeployableServer</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCADeployableServer cmdlet gets the servers that are ready for deployment. This cmdlet can be used to determine if an operating system can be deployed to a server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCADeployableServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs corresponding to servers. If no UUID is specified, all deployable servers are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCADeployableServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies an ID of OS image that can be deployed to target servers. If no image ID is specified, all deployable servers are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs corresponding to servers. If no UUID is specified, all deployable servers are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies an ID of an OS image that can be deployed to target servers. If no image ID is specified, all deployable servers are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployableServer</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCADeployableServer returns DeployableServer objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$servers = Get-LXCADeployableServer </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets a list of all deployable servers.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Import-LXCAOSImage</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Imports a local operating system image into the Lenovo XClarity Administrator server image repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Import</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Import-LXCAOSImage cmdlet imports a local operating system image into the Lenovo XClarity Administrator server image repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Import-LXCAOSImage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImagePath</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the file path and image name to be imported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Import-LXCAOSImage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImagePath</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the file path and image name to be imported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChecksumType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the checksum type, which can be MD5, SHA1 or SHA256. If you select one of these types, a checksum value is needed to check the integrity and security of the uploaded OS image.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChecksumValue</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the checksum value that will be used to check the integrity and security of the uploaded OS image..</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImagePath</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the file path and image name to be imported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChecksumType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the checksum type, which can be MD5, SHA1 or SHA256. If you select one of these types, a checksum value is needed to check the integrity and security of the uploaded OS image.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChecksumValue</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the checksum value that will be used to check the integrity and security of the uploaded OS image..</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the AsJob parameter, Import-LXCAOSImage returns a job object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Import-LXCAOSImage -ImagePath c:\ESXi-5.1.1-1065491-RTM-Lenovo-20130607-GA.iso $osimages = Get-LXCAOSImage </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command imports an operating system image into the Lenovo XClarity Administrator server image repository in synchronous mode.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$job = Import-LXCAOSImage -ImagePath c:\ESXi-5.1.1-1065491-RTM-Lenovo-20130607-GA.iso -AsJob while($job.State -eq "Running") { Start-Sleep -Seconds 5 } $osimages = Get-LXCAOSImage </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command imports a local operating system image into the Lenovo XClarity Administrator server image repository as a job that runs in the background.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-LXCAOSImage</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> <!-- Start do not translate block --> <command:name>Get-LXCAUpdateCompliancePolicy</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the update compliance policy from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAUpdateCompliancePolicy</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAUpdateCompliancePolicy cmdlet gets the update compliance policy information from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAUpdateCompliancePolicy</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAUpdateCompliancePolicy</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the reference system to which a compliance policy is assigned. The reference system can be a CMM, Flex switch, Flex System compute node, or System x server. If one policy has been assigned to the reference system, the returned policy instance includes the reference system UUID. If no reference system is specified, the cmdlet returns all policies.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the type of endpoint that was identified with the -SystemUuid parameter. Specify one of the following system types:</maml:para> <maml:para>- CMM. Reference system (specified by SystemUuid) is a CMM.</maml:para> <maml:para>- IOSwitch. Reference system (specified by SystemUuid) is a Flex switch.</maml:para> <maml:para>- ComputeNode. Reference system (specified by SystemUuid) is a Flex System compute node.</maml:para> <maml:para>- RackServer. Reference system (specified by SystemUuid) is a System x server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SystemUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the reference system to which a compliance policy is assigned. The reference system can be a CMM, Flex switch, Flex System compute node, or System x server. If one policy has been assigned to the reference system, the returned policy instance includes the reference system UUID. If no reference system is specified, the cmdlet returns all policies.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <!-- Start do not translate block --> <maml:name>SystemType</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the type of endpoint that was identified with the -SystemUuid parameter. Specify one of the following system types:</maml:para> <maml:para>- CMM. Reference system (specified by SystemUuid) is a CMM.</maml:para> <maml:para>- IOSwitch. Reference system (specified by SystemUuid) is a Flex switch.</maml:para> <maml:para>- ComputeNode. Reference system (specified by SystemUuid) is a Flex System compute node.</maml:para> <maml:para>- RackServer. Reference system (specified by SystemUuid) is a System x server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <dev:type> <maml:name>SystemType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.CompliancePolicy[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAUpdateCompliancePolicy returns a list of CompliancePolicy objects that contains update compliance policy information.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$policy = Get-LXCAUpdateCompliancePolicy</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns all update compliance policies.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$policy = Get-LXCAUpdateCompliancePolicy -SystemUuid 2B885CEB5B6711E1A12B5CF3FC11314A -SystemType ComputeNode</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns the update compliance policy that is applicable to compute node(2B885CEB5B6711E1A12B5CF3FC11314A).</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Set-LXCAUserAccount</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Modifies the properties for a user account on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Set</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Set-LXCAUserAccount cmdlet modifies the properties of a user account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCAUserAccount</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserAccount</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account to be modified.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RoleGroups</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the role groups to which the new user account will be assigned. The Lenovo XClarity Administrator includes several predefined role groups. You can also create customized role groups to manage authorization and access to resources on web UI.</maml:para> <maml:para>The following role groups are predefined in LXCA: LXC-SUPERVISOR. Users that are assigned this role canL access, configure, and perform all available operations on the hardware manager and all managed components. LXC-OPERATOR. Users that are assigned this role can view all configuration and status information on the hardware manager and all managed components. This role prohibits users from performing operations or modifying configurations settings on the hardware manager and managed components. LXC-SECURITY-ADMIN. Users that are assigned this role can modify security settings and perform security related operations on the hardware manager and managed components. This role also provides ability to view all configuration and status information on the hardware manager and managed components. LXC-ADMIN. Users that are assigned this role can modify non-security related settings and perform all non-security related operations on the hardware manager, including the ability to update and restart the hardware manager. This role also provides the ability to view all configuration and status information on the hardware manager and managed components. LXC-HW-ADMIN. Users that are assigned this role can modify non-security settings and perform non-security related operations on managed hardware, including the ability to update and restart managed hardware. LXC-FW-ADMIN. Users that are assigned this role can create firmware policies and deploy those policies to managed endpoints. Users that are not assigned this role can only view policy information. LXC-OS-ADMIN. Users that are assigned this role can download and deploy operating systems to managed endpoints. Users that are not assigned this role can only view operating-system information. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>State</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the state of the user account. Values can be Active or Inactive.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a description to be used for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserAccount</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account to be modified.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> <dev:type> <maml:name>UserAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RoleGroups</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the role groups to which the new user account will be assigned. The Lenovo XClarity Administrator includes several predefined role groups. You can also create customized role groups to manage authorization and access to resources on web UI.</maml:para> <maml:para>The following role groups are predefined in LXCA: LXC-SUPERVISOR. Users that are assigned this role canL access, configure, and perform all available operations on the hardware manager and all managed components. LXC-OPERATOR. Users that are assigned this role can view all configuration and status information on the hardware manager and all managed components. This role prohibits users from performing operations or modifying configurations settings on the hardware manager and managed components. LXC-SECURITY-ADMIN. Users that are assigned this role can modify security settings and perform security related operations on the hardware manager and managed components. This role also provides ability to view all configuration and status information on the hardware manager and managed components. LXC-ADMIN. Users that are assigned this role can modify non-security related settings and perform all non-security related operations on the hardware manager, including the ability to update and restart the hardware manager. This role also provides the ability to view all configuration and status information on the hardware manager and managed components. LXC-HW-ADMIN. Users that are assigned this role can modify non-security settings and perform non-security related operations on managed hardware, including the ability to update and restart managed hardware. LXC-FW-ADMIN. Users that are assigned this role can create firmware policies and deploy those policies to managed endpoints. Users that are not assigned this role can only view policy information. LXC-OS-ADMIN. Users that are assigned this role can download and deploy operating systems to managed endpoints. Users that are not assigned this role can only view operating-system information. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>State</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the state of the user account. Values can be Active or Inactive.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a description to be used for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCAUserAccount returns the UserAccount object which contains the modified value.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$account = Get-LXCAUserAccount | where { $_.UserName -eq "testuser" } $newaccount = Set-LXCAUserAccount -UserAccount $account -RoleGroups LXC-SUPERVISOR,LXC-ADMIN -Description "new full name" </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command modifies the RoleGroups and Description property for a user account named testuser.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAUserAccount</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> <!-- Start do not translate block --> <command:name>Add-LXCAUserAccount</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Adds an Lenovo XClarity Administrator user account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Add</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Add-LXCAUserAccount cmdlet adds a user account to the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAUserAccount</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user ID of the new user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password of the new user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RoleGroups</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the role groups to which the new user account is to be assigned. Lenovo XClarity Administrator includes the following predefined role groups. You can also create customized role groups to manage authorization and access to resources on web UI. LXC-SUPERVISOR. Users that are assigned this role canL access, configure, and perform all available operations on the hardware manager and all managed components. LXC-OPERATOR. Users that are assigned this role can view all configuration and status information on the hardware manager and all managed components. This role prohibits users from performing operations or modifying configurations settings on the hardware manager and managed components. LXC-SECURITY-ADMIN. Users that are assigned this role can modify security settings and perform security related operations on the hardware manager and managed components. This role also provides ability to view all configuration and status information on the hardware manager and managed components. LXC-ADMIN. Users that are assigned this role can modify non-security related settings and perform all non-security related operations on the hardware manager, including the ability to update and restart the hardware manager. This role also provides the ability to view all configuration and status information on the hardware manager and managed components. LXC-HW-ADMIN. Users that are assigned this role can modify non-security settings and perform non-security related operations on managed hardware, including the ability to update and restart managed hardware. LXC-FW-ADMIN. Users that are assigned this role can create firmware policies and deploy those policies to managed endpoints. Users that are not assigned this role can only view policy information. LXC-OS-ADMIN. Users that are assigned this role can download and deploy operating systems to managed endpoints. Users that are not assigned this role can only view operating-system information. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PasswordChangeFirstAccess</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that the password must be changed the first time it is used. The default value is True.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description of the new user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user ID of the new user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password of the new user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RoleGroups</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the role groups to which the new user account is to be assigned. Lenovo XClarity Administrator includes the following predefined role groups. You can also create customized role groups to manage authorization and access to resources on web UI. LXC-SUPERVISOR. Users that are assigned this role canL access, configure, and perform all available operations on the hardware manager and all managed components. LXC-OPERATOR. Users that are assigned this role can view all configuration and status information on the hardware manager and all managed components. This role prohibits users from performing operations or modifying configurations settings on the hardware manager and managed components. LXC-SECURITY-ADMIN. Users that are assigned this role can modify security settings and perform security related operations on the hardware manager and managed components. This role also provides ability to view all configuration and status information on the hardware manager and managed components. LXC-ADMIN. Users that are assigned this role can modify non-security related settings and perform all non-security related operations on the hardware manager, including the ability to update and restart the hardware manager. This role also provides the ability to view all configuration and status information on the hardware manager and managed components. LXC-HW-ADMIN. Users that are assigned this role can modify non-security settings and perform non-security related operations on managed hardware, including the ability to update and restart managed hardware. LXC-FW-ADMIN. Users that are assigned this role can create firmware policies and deploy those policies to managed endpoints. Users that are not assigned this role can only view policy information. LXC-OS-ADMIN. Users that are assigned this role can download and deploy operating systems to managed endpoints. Users that are not assigned this role can only view operating-system information. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PasswordChangeFirstAccess</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that the password must be changed the first time it is used. The default value is True.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description of the new user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAUserAccount returns the UserAccount object if successful.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$pwd = ConvertTo-SecureString "password" -AsPlainText –Force $account = Add-LXCAUserAccount -UserName USERID1 -Password $pwd -RoleGroups LXC-SUPERVISOR,LXC-ADMIN -PasswordChangeFirstAccess $true </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command creates a user account.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-LXCAUserAccount</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> <!-- Start do not translate block --> <command:name>Install-LXCAConfigPattern</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Deploys a server pattern to one or more target systems (endpoints).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Install</command:verb> <command:noun>LXCAConfigPattern</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Install-LXCAConfigPattern cmdlet deploys a server pattern to one or more target systems (endpoints).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Install-LXCAConfigPattern</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a server pattern ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetComputeNodeId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of target Flex System compute node IDs. If a target is an empty bay, it is a location ID; otherwise it is a server UUID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Restart</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart target server.</maml:para> <maml:para>- Immediate. The server is powered on or restarted immediately, which will activate all IMM, UEFI, and server configuration changes.</maml:para> <maml:para>- Defer. IMM changes are activated immediately. However, UEFI and server configuration changes are not activated until the next server restart.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Install-LXCAConfigPattern</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a server pattern ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetRackServerId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of target System x server IDs. The ID is the server location ID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Restart</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart target server.</maml:para> <maml:para>- Immediate. The server is powered on or restarted immediately, which will activate all IMM, UEFI, and server configuration changes.</maml:para> <maml:para>- Defer. IMM changes are activated immediately. However, UEFI and server configuration changes are not activated until the next server restart.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a server pattern ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetComputeNodeId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of target Flex System compute node IDs. If a target is an empty bay, it is a location ID; otherwise it is a server UUID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetRackServerId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a list of target System x server IDs. The ID is the server location ID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Restart</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart target server.</maml:para> <maml:para>- Immediate. The server is powered on or restarted immediately, which will activate all IMM, UEFI, and server configuration changes.</maml:para> <maml:para>- Defer. IMM changes are activated immediately. However, UEFI and server configuration changes are not activated until the next server restart.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigPatternDeployResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAConfigPattern returns one or more ConfigPatternDeployResult objects when the AsJob parameter is not used.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAConfigPattern returns a job object when the AsJob parameter is used. The ConfigPatternDeployResult[] can be retrieved from Job.Output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$patterns = Get-LXCAConfigPattern $targetchassis = Get-LXCAConfigPatternDeployableServer -PatternId $patterns[0].Id Install-LXCAConfigPattern -PatternId $patterns[0].Id -TargetComputeNodeId $targetchassis[0].Servers[0].Id -restart defer </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command deploys a server pattern to a target Flex System compute node and defers the activation until the next restart.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAConfigPatternDeployableServer</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> <!-- Start do not translate block --> <command:name>Install-LXCAConfigProfile</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Deploys a server profile to a specific target system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Install</command:verb> <command:noun>LXCAConfigProfile</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Install-LXCAConfigProfile cmdlet deploys a server profile to a specific target system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Install-LXCAConfigProfile</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a server profile ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetComputeNodeId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a target Flex System compute node ID. If the target is an empty bay, it is a location ID; otherwise it is a server UUID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Restart</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart the target server.</maml:para> <maml:para>- Immediate. The server is powered on or restarted immediately, which will activate all IMM, UEFI, and server configuration changes.</maml:para> <maml:para>- Defer. IMM changes are activated immediately. However, UEFI and server configuration changes are not activated until the next server restart.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Install-LXCAConfigProfile</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a server profile ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetRackServerId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a target System x server ID. The ID is the server location ID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Restart</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart target server.</maml:para> <maml:para>- Immediate. The server is powered on or restarted immediately, which will activate all IMM, UEFI, and server configuration changes.</maml:para> <maml:para>- Defer. IMM changes are activated immediately. However, UEFI and server configuration changes are not activated until the next server restart.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ProfileId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a server profile ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetComputeNodeId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a target Flex System compute node ID. If the target is an empty bay, it is a location ID; otherwise it is a server UUID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetRackServerId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a target System x server ID. The ID is the server location ID. To obtain the value, use Get-LXCAConfigPatternDeployableServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Restart</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart target server.</maml:para> <maml:para>- Immediate. The server is powered on or restarted immediately, which will activate all IMM, UEFI, and server configuration changes.</maml:para> <maml:para>- Defer. IMM changes are activated immediately. However, UEFI and server configuration changes are not activated until the next server restart.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigPatternDeployResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAConfigProfile returns a ConfigPatternDeployResult object when the AsJob parameter is not used.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAConfigProfile returns a job object when the AsJob parameter is used. The ConfigPatternDeployResult can be retrieved from Job.Output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$profile = Get-LXCAConfigProfile | where {$_.ServerUuid -ieq AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA} Remove-LXCAConfigProfileFromSystem -Profile $profile Install-LXCAConfigProfile -ProfileId $profile.Id -TargetComputeNodeId BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB -restart defer </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets a server profile from server AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA and deploys it to server BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAConfigPatternDeployableServer</maml:linkText> <maml:linkText>Remove-LXCAConfigProfileFromSystem</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> <!-- Start do not translate block --> <command:name>Set-LXCASystemIPInterface</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Sets the system IP interface of a chassis, a compute node, a rack server, or an I/O module (switch).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Set</command:verb> <command:noun>LXCASystemIPInterface</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Set-LXCASystemIPInterface cmdlet sets the IP interface of a chassis, a compute node, a rack server or an I/O module (switch), including DHCP mode, gateway, address, and other settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemIPInterface</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CMMUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a chassis primary CMM for which you want to set the IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>InterfaceName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the IP interface to be modified (for example, eth0 or eth1). Tip: Use the endpoint inventory cmdlet to retrieve the current interface name, such as Get-LXCAChassisInventory or Get-LXCARackServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4DHCPmode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 DHCP mode. You can specify one of the following values:</maml:para> <maml:para>- DHCP_only. Obtain the IP address from a DHCP server only.</maml:para> <maml:para>- DHCP_then_Static. Attempt to obtain the IP address from a DHCP server. If not successful, use a static IP configuration.</maml:para> <maml:para>- Static. Use a static IP configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Subnet</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 subnet mask to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 gateway address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6DHCPenabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StatelessEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StaticEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Prefix</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemIPInterface</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex System compute node for which you want to set the IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>InterfaceName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the IP interface to be modified (for example, eth0 or eth1). Tip: Use the endpoint inventory cmdlet to retrieve the current interface name, such as Get-LXCAChassisInventory or Get-LXCARackServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4DHCPmode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 DHCP mode. You can specify one of the following values:</maml:para> <maml:para>- DHCP_only. Obtain the IP address from a DHCP server only.</maml:para> <maml:para>- DHCP_then_Static. Attempt to obtain the IP address from a DHCP server. If not successful, use a static IP configuration.</maml:para> <maml:para>- Static. Use a static IP configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Subnet</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 subnet mask to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 gateway address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6DHCPenabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StatelessEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StaticEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Prefix</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemIPInterface</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a System x server for which you want to set the IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>InterfaceName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the IP interface to be modified (for example, eth0 or eth1). Tip: Use the endpoint inventory cmdlet to retrieve the current interface name, such as Get-LXCAChassisInventory or Get-LXCARackServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4DHCPmode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 DHCP mode. You can specify one of the following values:</maml:para> <maml:para>- DHCP_only. Obtain the IP address from a DHCP server only.</maml:para> <maml:para>- DHCP_then_Static. Attempt to obtain the IP address from a DHCP server. If not successful, use a static IP configuration.</maml:para> <maml:para>- Static. Use a static IP configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Subnet</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 subnet mask to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 gateway address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6DHCPenabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StatelessEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StaticEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Prefix</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemIPInterface</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex switch for which you want to set the IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>InterfaceName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the IP interface to be modified (for example, eth0 or eth1). Tip: Use the endpoint inventory cmdlet to retrieve the current interface name, such as Get-LXCAChassisInventory or Get-LXCARackServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4DHCPmode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 DHCP mode. You can specify one of the following values:</maml:para> <maml:para>- DHCP_only. Obtain the IP address from a DHCP server only.</maml:para> <maml:para>- DHCP_then_Static. Attempt to obtain the IP address from a DHCP server. If not successful, use a static IP configuration.</maml:para> <maml:para>- Static. Use a static IP configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Subnet</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 subnet mask to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 gateway address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6DHCPenabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StatelessEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StaticEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Prefix</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CMMUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a chassis primary CMM for which you want to set the IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex System compute node for which you want to set the IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a System x server for which you want to set the IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex switch for which you want to set IP interface.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>InterfaceName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the name of the IP interface to be modified (for example, eth0 or eth1). Tip: Use the endpoint inventory cmdlet to retrieve the current interface name, such as Get-LXCAChassisInventory or Get-LXCARackServer.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4DHCPmode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 DHCP mode. You can specify one of the following values:</maml:para> <maml:para>- DHCP_only. Obtain the IP address from a DHCP server only.</maml:para> <maml:para>- DHCP_then_Static. Attempt to obtain the IP address from a DHCP server. If not successful, use a static IP configuration.</maml:para> <maml:para>- Static. Use a static IP configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Subnet</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 subnet mask to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 gateway address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv4 address to be used when DHCP mode is set to Static or DHCP_then_Static.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6DHCPenabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StatelessEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv6StaticEnabled</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Gateway</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Prefix</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StaticIPv6Address</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCASystemIPInterface does not return object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Set-LXCASystemIPInterface -RackServerUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -InterfaceName eth0 -IPv4DHCPmode Static -IPv4Subnet 255.255.255.0 -IPv4Gateway 10.10.10.1 -IPv4Address 10.10.10.121 </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command sets the static IPv4 configuration for a System x server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCAScalableComplexSystem</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets information about one or more scalable complex system (either a System x server or a Flex System compute node) that is currently managed by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAScalableComplexSystem</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAScalableComplexSystem cmdlet returns information about one or more scalable complex system (either a System x server or a Flex System compute node) that is currently managed by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAScalableComplexSystem</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the ID of one or more scalable complex systems.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServer</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that the scalable complex system is created from System x servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAScalableComplexSystem</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the ID of one or more scalable complex systems.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that the scalable complex system is created from Flex System compute nodes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the ID of one or more scalable complex systems.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServer</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that the scalable complex system is created from System x servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that the scalable complex system is created from Flex System compute nodes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ComplexForComputeNode or Lenovo.SysMgmt.LXCA.Integration.Data.ComplexForRackServer</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAScalableComplexSystem returns ComplexForComputeNode or ComplexForRackServer object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Get-LXCAScalableComplexSystem -RackServer </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns all scalable complex systems created from System x servers.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- ID Reviewed End --> <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> <!-- Start do not translate block --> <command:name>Get-LXCAConfigPattern</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets one or more server patterns from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAConfigPattern</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAConfigPattern cmdlet gets information about one or more server patterns from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAConfigPattern</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the pattern ID. If no PatternID is specified, all configuration patterns are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IncludeSettings</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlets returns the detailed definition (settings) of the pattern.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PatternID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the pattern ID. If no PatternID is specified, all configuration patterns are returned.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IncludeSettings</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlets returns the detailed definition (settings) of the pattern.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigPattern[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAConfigPattern returns a list of config pattern objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$patterns = Get-LXCAConfigPattern</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all server patterns from the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$pattern = Get-LXCAConfigPattern -PatternId 33 -IncludeSettings $pattern.Settings </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets server pattern with ID "33", the result includes detail pattern settings.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAConfigProfile</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> <!-- Start do not translate block --> <command:name>Import-LXCAConfigPattern</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Imports a configuration pattern to the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Import</command:verb> <command:noun>LXCAConfigPattern</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Import-LXCAConfigPattern cmdlet imports a configuration pattern to the Lenovo XClarity Administrator server. The pattern setting must be the JSON in correct format.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Import-LXCAConfigPattern</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Settings</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the configuration-pattern settings. The setting must be the JSON in correct format. To ensure the correct format, use an existing configuration pattern as a template.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Settings</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the configuration-pattern settings. The setting must be the JSON in correct format. To ensure the correct format, use an existing configuration pattern as a template.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>String</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Import-LXCAConfigPattern returns the new ID of imported config pattern.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$settings = Get-Content -Path "c:\pattern_setting.txt" Import-LXCAConfigPattern -Setting $settings </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command reads pattern setting from local file and import the pattern to the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-LXCAConfigPattern</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> <!-- Start do not translate block --> <command:name>Invoke-LXCARestMethod</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Invoke a Lenovo XClarity Administrator REST API directly.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Invoke</command:verb> <command:noun>LXCARestMethod</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Invoke-LXCARestMethod cmdlet invokes a Lenovo XClarity Administrator REST API directly.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCARestMethod</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ResourceUrl</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the resource URL.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Method</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the http request method, available methods: GET, POST, PUT, DELETE, PATCH.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AdditionalHeaders</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the additional request headers. These headers are not supported: Accept, Connection, Content-Length, Content-Type, Expect, Date, Host, If-Modified-Since, Range, Referer, Transfer-Encoding and User-Agent.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RequestBody</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the request body (string)</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCARestMethod</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ResourceUrl</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the resource URL.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Method</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the http request method, available methods: GET, POST, PUT, DELETE, PATCH.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AdditionalHeaders</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the additional request headers. These headers are not supported: Accept, Connection, Content-Length, Content-Type, Expect, Date, Host, If-Modified-Since, Range, Referer, Transfer-Encoding and User-Agent.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RequestBody</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the request body (string)</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>OutFile</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the output directory and file name in which to return the response body. If you do not specify a directory, the output file is saved in the current location.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ResourceUrl</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the resource URL.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Method</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the http request method, available methods: GET, POST, PUT, DELETE, PATCH.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AdditionalHeaders</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the additional request headers. These headers are not supported: Accept, Connection, Content-Length, Content-Type, Expect, Date, Host, If-Modified-Since, Range, Referer, Transfer-Encoding and User-Agent.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RequestBody</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the request body (string)</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>OutFile</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the output directory and file name in which to return the response body. If you do not specify a directory, the output file is saved in the current location.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>LXCARestResponse</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If there is no -OutFile parameter, cmdlet Invoke-LXCARestMethod returns a LXCARestResponse instance which include the http response headers, http status code and response body.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>LXCARestResponseOutFile</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If there is a -OutFile parameter, cmdlet Invoke-LXCARestMethod returns a LXCARestResponseOutFile instance which include the http response headers, http status code and full path of the out file.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$url = "/nodes" $headers = @{'Item'='10';} $restResult = Invoke-LXCARestMethod -ResourceUrl url -Method GET -AdditionalHeaders $additionalHeader $restResult.HttpStatusCode $restResult.Headers $restResult.Body </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command sends a 'GET' request to REST API '/nodes' with additional header (Item=10).</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>None</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> <!-- Start do not translate block --> <command:name>Get-LXCAEvent</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets one or more events from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAEvent</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAEvent cmdlet gets one or more events from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAEvent</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PreviousHours</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StartSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EndSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>All</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlets also returns the audit log entries.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event ID.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SourceID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Severity</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event severity.</maml:para> <maml:para>Severity values are Unknown, Informational, Warning, Minor, Major, Critical, and Fatal. Multiple values must be separated by a comma.</maml:para> <maml:para>The severity definition on Lenovo XClarity Administrator web UI is different with the severity levels here, "Critical" on UI maps to "Major, Critical, Fatal" here, "Warning" on UI maps to "Warning, Minor" here, "Informational" on UI equals "Informational" here, "Unknown" on UI equals "Unknown" here.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EventClass</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the event source type.</maml:para> <maml:para>Event source types are Blade, Switch IOModule, Expansion, Adaptor, System, Processors, Memory, Disks, Power, Cooling, Audit, Test, and Unknown. Multiple values must be separated by a comma.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PreviousHours</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>StartSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EndSequenceNumber</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>All</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlets also returns the audit log entries.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Event[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAEvent returns Event objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$events = Get-LXCAEvent -Severity Critical </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the critical events from the Lenovo XClarity Administrator server.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$events = Get-LXCAEvent -Severity Major,Critical,Fatal -EventClass Blade -PreviousHours 12 </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the major, critical and fatal events that have occurred in the previous 12 hours.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$events = Get-LXCAEvent -Severity Major,Critical,Fatal -StartSequenceNumber 100 -EndSequenceNumber 1000 </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all the major,critical and fatal events which is in sequence number range [100, 1000].</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Set-LXCASystemProperty</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Sets system properties for a chassis, Flex System compute node, System x server, ThinkServer server or RackSwitch top-of-rack switch.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Set</command:verb> <command:noun>LXCASystemProperty</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Set-LXCASystemProperty cmdlet sets the properties for a chassis, Flex System compute node, System x server, ThinkServer server or RackSwitch top-of-rack switch, including host name, description, contact, and display name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemProperty</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a chassis for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DisplayName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Hostname</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Contact</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EncapsulationMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemProperty</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex system compute node for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DisplayName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Hostname</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the host name to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Contact</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EncapsulationMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemProperty</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a System x server for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DisplayName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Hostname</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Contact</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EncapsulationMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemProperty</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a think server for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DisplayName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Hostname</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Contact</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Set-LXCASystemProperty</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a RackSwitch top-of-rack switch for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DisplayName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Contact</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a chassis for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex System compute node for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a System x server for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a ThinkServer server for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a RackSwitch top-of-rack switch for which you want to set the properties.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DisplayName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Hostname</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Description</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Contact</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>EncapsulationMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCASystemProperty does not return object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Set-LXCASystemProperty -ChassisUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -DisplayName "Display Name" -Contact "Admin" </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command sets the display name and contact values for a chassis.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Invoke-LXCASystemAction</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Invokes a system action, such as power on, power off, restart, or virtual reseat for a CMM, Flex System compute node, System x server, ThinkServer server, storage canister, Flex switch, or RackSwitch top-of-rack switch.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Invoke</command:verb> <command:noun>LXCASystemAction</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Invoke-LXCASystemAction cmdlet allows you to power on, power off, restart, or virtual reseat for a CMM, Flex System compute node, System x server, ThinkServer server, storage canister, Flex switch, or RackSwitch top-of-rack switch.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCASystemAction</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CMMUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a CMM as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CMMAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target CMM. -Reset </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCASystemAction</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex System compute node as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target Flex System compute node. -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -VirtualReseat </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCASystemAction</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CanisterUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a storage canister as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CanisterAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target storage canister. -PowerOn -PowerOff -Restart </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCASystemAction</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IOSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of an I/O module (Flex switch) as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IOSwitchAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target I/O module. -PowerOn -PowerOff -Reset </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCASystemAction</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a System x server as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target System x server. -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -ReseatIMM </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCASystemAction</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a ThinkServer server as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target ThinkServer server. -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -ResetBMC </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Invoke-LXCASystemAction</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a RackSwitch top-of-rack switch as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target RackSwitch top-of-rack switch. -Restart </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CMMUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a CMM as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CMMAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target CMM. -Reset </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a Flex System compute node as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ComputeNodeAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target Flex System compute node. -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -VirtualReseat </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CanisterUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a storage canister as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CanisterAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target storage canister. -PowerOn -PowerOff -Restart </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IOSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of an I/O module (Flex switch) as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IOSwitchAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target I/O module. -PowerOn -PowerOff -Reset </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a System x server as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target System x server. -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -ReseatIMM </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a ThinkServer server as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target ThinkServer server. -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -ReseatBMC </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of a RackSwitch top-of-rack switch as the target for the system action.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchAction</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the action to be performed on the target RackSwitch top-of-rack switch. -Restart </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Force</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Invoke-LXCASystemAction does not return an object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>Invoke-LXCASystemAction -ComputeNodeUuid AAAAAAAAAAAA -ComputeNodeAction PowerOn -Force </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command powers on the compute node AAAAAAAAAAAA.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>Get-LXCADeployGlobalSetting</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets the global settings used for operating system deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCADeployGlobalSetting</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCADeployGlobalSetting cmdlet gets the global settings used to deploy operating systems, such as IP assignment type (static or DHCP) and deployment credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCADeployGlobalSetting</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployGlobalSetting</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para> public class DeployGlobalSetting { public CredentialSetting[] Credentials; public string IpAssignment; //staticv4|dhcpv4 public ActiveDirectorySetting ActiveDirectory; public LicenseKeySetting LicenseKeys; public bool IsVlanMode; //True to take advantage of VLAN tagging public class CredentialSetting { public string Type; //"ESXi", "LINUX", or "WINDOWS", readonly // "RHEL/ESXi" can also be use, but will be deprecated in a future release. public string Name; //"root" or "administrator", readonly public string Password; //Empty string } public class ActiveDirectorySetting { public DomainSetting[] AllDomains; public string DefaultDomain; public class DomainSetting { public int ID; public string DomainName; public string OU; } } public class LicenseKeySetting { public Win2012R1Key Win2012R1; public Win2012R2Key Win2012R2; public class Win2012R1Key { public string StandardLicenseKey; public string DataCenterLicenseKey; } public class Win2012R2Key { public string StandardLicenseKey; public string DataCenterLicenseKey; } } } </maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCADeployGlobalSetting returns DeployGlobalSetting instance.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$setting = Get-LXCADeployGlobalSetting </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets the global settings used for operating system deployment.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-LXCADeployGlobalSetting</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> <!-- Start do not translate block --> <command:name>Add-LXCAManagedDevice</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Manages one or more chassis, System x servers, ThinkServer servers, or RackSwitch top-of-rack switches on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Add</command:verb> <command:noun>LXCAManagedDevice</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Add-LXCAManagedDevice cmdlet manages one or more chassis, System x servers, ThinkServer servers or RackSwitch top-of-rack switches on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAManagedDevice</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of chassis to be managed by the Lenovo XClarity Administrator server. The chassis must have already been discovered. Tip: Use the Get-LXCAChassis -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Username</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a user account with supervisor privileges. If the device to be managed is a chassis, specify a user account for the CMM in that chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisRecoveryPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the chassis recovery ID password.</maml:para> <maml:para>When you manage a chassis, the CMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local CMM user accounts are no longer valid. You can use the RECOVERY_ID to access the CMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify and store it in a secure location.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceManage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the endpoints are managed by this Lenovo XClarity Administrator server even if they are already managed by another Lenovo XClarity Administrator server. An endpoint can be managed by only one Lenovo XClarity Administrator server at a time. Management by multiple managers is not supported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAManagedDevice</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs System x of rack servers to be managed by the Lenovo XClarity Administrator server. The rack servers must have already been discovered. Tip: Use the Get-LXCARackServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed System x servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Username</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a user account with supervisor privileges. If the device to be managed is a chassis, specify a user account for the CMM in that chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceManage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the endpoints are managed by this Lenovo XClarity Administrator server even if they are already managed by another Lenovo XClarity Administrator server. An endpoint can be managed by only one Lenovo XClarity Administrator server at a time. Management by multiple managers is not supported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAManagedDevice</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs for ThinkServer tower or rack servers to be managed by the Lenovo XClarity Administrator server. The servers must have already been discovered. Tip: Use the Get-LXCAThinkServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed ThinkServer tower or rack servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Username</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a user account with supervisor privileges. If the device to be managed is a chassis, specify a user account for the CMM in that chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceManage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the endpoints are managed by this Lenovo XClarity Administrator server even if they are already managed by another Lenovo XClarity Administrator server. An endpoint can be managed by only one Lenovo XClarity Administrator server at a time. Management by multiple managers is not supported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAManagedDevice</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IpAddress</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more IPv4 addresses of chassis, System x servers, and ThinkServer servers be managed by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Username</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a user account with supervisor privileges. If the device to be managed is a chassis, specify a user account for the CMM in that chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisRecoveryPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the chassis recovery password.</maml:para> <maml:para>When you manage a chassis, the CMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local CMM user accounts are no longer valid. You can use the RECOVERY_ID to access the CMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify and store it in a secure location.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceManage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the endpoints are managed by this Lenovo XClarity Administrator server even if they are already managed by another Lenovo XClarity Administrator server. </maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAManagedDevice</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Range</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more ranges of IPv4 addresses. Use a format similar to 192.168.9.1-192.168.9.10 to specify a range.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Username</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a user account with supervisor privileges. If the device to be managed is a chassis, specify a user account for the CMM in that chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisRecoveryPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the chassis recovery password.</maml:para> <maml:para>When you manage a chassis, the CMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local CMM user accounts are no longer valid. You can use the RECOVERY_ID to access the CMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify and store it in a secure location.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceManage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the endpoints are managed by this Lenovo XClarity Administrator server even if they are already managed by another Lenovo XClarity Administrator server. An endpoint can be managed by only one Lenovo XClarity Administrator server at a time. Management by multiple managers is not supported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Add-LXCAManagedDevice</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>BulkImportFile</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the path of the bulk-import file to use to manage multiple devices. The file template in CSV format can be downloaded from the Lenovo XClarity Administrator web interface. Note: You cannot manage ThinkServer servers using the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentRackServerUserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account for the rack server if you specify the -BulkImportFile parameter. This name is used if a user name is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentRackServerPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account that is specified using the -CurrentRackServerUsername parameter. This password is used if a password is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NewRackServerPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the new password for the user account that is specified using the -CurrentRackServerUsername parameter. This password is used only if the current password is expired.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentChassisUserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account for the chassis if you specify the -BulkImportFile parameter. This name is used if there a user name is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentChassisPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account that is specified using the -CurrentChassisUsername parameter. This password is used if a password is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NewChassisPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the new password for the user account that is specified using the -CurrentChassisUsername parameter. This password is used only if the current password is expired.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisRecoveryPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the chassis recovery password.</maml:para> <maml:para>When you manage a chassis, the CMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local CMM user accounts are no longer valid. You can use the RECOVERY_ID to access the CMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify and store it in a secure location.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of chassis to be managed by the Lenovo XClarity Administrator server. The chassis must have already been discovered. Tip: Use the Get-LXCAChassis -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs System x of rack servers to be managed by the Lenovo XClarity Administrator server. The rack servers must have already been discovered. Tip: Use the Get-LXCARackServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed System x servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs for ThinkServer tower or rack servers to be managed by the Lenovo XClarity Administrator server. The servers must have already been discovered. Tip: Use the Get-LXCAThinkServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed ThinkServer tower or rack servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IpAddress</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more IPv4 addresses of chassis, System x servers, and ThinkServer servers be managed by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IPv4Range</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more ranges of IPv4 addresses. Use a format similar to 192.168.9.1-192.168.9.10 to specify a range.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Username</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies a user account with supervisor privileges. If the device to be managed is a chassis, specify a user account for the CMM in that chassis.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Password</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisRecoveryPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the chassis recovery ID password.</maml:para> <maml:para>When you manage a chassis, the CMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local CMM user accounts are no longer valid. You can use the RECOVERY_ID to access the CMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify and store it in a secure location.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>BulkImportFile</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the path of the bulk-import file to use to manage multiple devices. The file template in CSV format can be downloaded from the Lenovo XClarity Administrator web interface. Note: You cannot manage ThinkServer servers using the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentRackServerUserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account for the rack server if you specify the -BulkImportFile parameter. This name is used if a user name is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentRackServerPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account that is specified using the -CurrentRackServerUsername parameter. This password is used if a password is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NewRackServerPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the new password for the user account that is specified using the -CurrentRackServerUsername parameter. This password is used only if the current password is expired.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentChassisUserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the user account for the chassis if you specify the -BulkImportFile parameter. This name is used if there a user name is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>CurrentChassisPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the password for the user account that is specified using the -CurrentChassisUsername parameter. This password is used if a password is not defined in the bulk-import file.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>NewChassisPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the new password for the user account that is specified using the -CurrentChassisUsername parameter. This password is used only if the current password is expired.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceManage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the endpoints are managed by this Lenovo XClarity Administrator server even if they are already managed by another Lenovo XClarity Administrator server. An endpoint can be managed by only one Lenovo XClarity Administrator server at a time. Management by multiple managers is not supported.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ManageDeviceResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAManagedDevice returns a ManageDeviceResult object if there is no Uuid is specified.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ChassisManageResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAManagedDevice returns a ChassisManageResult object when parameter ChassisUuid is specified.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackServerManageResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAManagedDevice returns a RackServerManageResult object when parameter RackServerUuid is specified.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ThinkServerManageResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAManagedDevice returns a ThinkServerManageResult object when parameter ThinkServerUuid is specified.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackSwitchManageResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAManagedDevice returns a RackSwitchManageResult object when parameter RackSwitchUuid is specified.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the AsJob parameter, Add-LXCAManagedDevice returns a job object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$unmanagedchassis = Get-LXCAChassis -Unmanaged $password = ConvertTo-SecureString "Password" -AsPlainText –Force $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText –Force foreach ($chassis in $unmanagedchassis) { Add-LXCAManagedDevice -ChassisUuid $chassis.uuid -Username USERID -Password $password -ChassisRecoveryPassword $recoveryPwd } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets all chassis that have been discovered but that are currently unmanaged. It then puts them under Lenovo XClarity Administrator management.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$password = ConvertTo-SecureString "Password" -AsPlainText –Force $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText –Force $job = Add-LXCAManagedDevice -IpAddress 1.111.11.11 -Username USERID -Password $password -ChassisRecoveryPassword $recoveryPwd -AsJob while($job.State -eq "Running") { Start-Sleep -Seconds 5 } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command adds an undiscovered chassis as a job that runs in the background.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$password = ConvertTo-SecureString "Password" -AsPlainText –Force $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText –Force Add-LXCAManagedDevice -Ipv4Range 1.111.11.11-1.111.11.20 -Username USERID -Password $password -ChassisRecoveryPassword $recoveryPwd </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command manages multiple endpoints using an IPv4 address range.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$password = ConvertTo-SecureString "Password" -AsPlainText –Force Add-LXCAManagedDevice -BulkImportFile c:\buikimport.csv -CurrentRackServerUsername USERID -CurrentRackServerPassword $password </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command uses a bulk import file to management multiple devices.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-LXCAManagedDevice</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> <!-- Start do not translate block --> <command:name>Remove-LXCAManagedDevice</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Removes one or more devices (chassis, rack server, think server or rack switch) from management by the Lenovo XClarity Administrator server (unmanages devices). </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Remove</command:verb> <command:noun>LXCAManagedDevice</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Remove-LXCAManagedDevice cmdlet removes one or more devices from management by the Lenovo XClarity Administrator server (unmanages devices).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Remove-LXCAManagedDevice</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the System x servers that are to be unmanaged by Lenovo XClarity Administrator. The System x servers must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the chassis that are to be unmanaged by Lenovo XClarity Administrator. The chassis must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the ThinkServer servers that are to be unmanaged by Lenovo XClarity Administrator. The ThinkServer servers must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the RackSwitch top-of-rack switches that are to be unmanaged by Lenovo XClarity Administrator. The RackSwitch top-of-rack switches must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceUnmanage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Force unmanage even if the endpoint is not reachable.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as a background job and returns a job object immediately. Otherwise the cmdlet will run in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the System x servers that are to be unmanaged by Lenovo XClarity Administrator. The System x servers must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ChassisUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the chassis that are to be unmanaged by Lenovo XClarity Administrator. The chassis must have been managed by Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ThinkServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the ThinkServer servers that are to be unmanaged by Lenovo XClarity Administrator. The ThinkServer servers must have been managed by Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>RackSwitchUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUIDs of the RackSwitch top-of-rack switches that are to be unmanaged by Lenovo XClarity Administrator. The RackSwitch top-of-rack switches must have been managed by Lenovo XClarity Administrator previously.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceUnmanage</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Force unmanage even if the endpoint is not reachable.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as a background job and returns a job object immediately. Otherwise the cmdlet will run in synchronous mode.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCAManagedDevice does not return object normally.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the AsJob parameter, Remove-LXCAManagedDevice returns a job object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$managedchassis = Get-LXCAChassis $chassisUuids = @() Foreach($chassis in $managedchassis) { $chassisUuids += $chassis.Uuid } Remove-LXCAManagedDevice -ChassisUuid $chassisUuids </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command unmanages all chassis that have been managed by the Lenovo XClarity Administrator.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$chassis = Get-LXCAChassis $job = Remove-LXCAManagedDevice -ChassisUuid $chassis[0].Uuid -AsJob while ($job.State -eq "Running") { Start-Sleep -Seconds 5 } </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command removes a managed chassis from Lenovo XClarity Administrator management in asynchronous mode.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-LXCAManagedDevice</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> <!-- Start do not translate block --> <command:name>Get-LXCARackSwitch</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets inventory data about one or more RackSwitch top-of-rack switches from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCARackSwitch</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCARackSwitch cmdlet gets inventory data about one or more RackSwitch top-of-rack switches from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCARackSwitch</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all RackSwitch top-of-rack switches that are not currently managed. If not specified, this cmdlet returns all managed RackSwitch top-of-rack switches.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCARackSwitch</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of RackSwitch top-of-rack switches. If no UUID is specified, the cmdlet returns all managed RackSwitch top-of-rack switches unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all RackSwitch top-of-rack switches that are not currently managed. If not specified, this cmdlet returns all managed RackSwitch top-of-rack switches.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of RackSwitch top-of-rack switches. If no UUID is specified, the cmdlet returns all managed RackSwitch top-of-rack switches unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all RackSwitch top-of-rack switches that are not currently managed. If not specified, this cmdlet returns all managed RackSwitch top-of-rack switches.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe any object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackSwitch[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCARackSwitch returns a list of rack switches.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$rackswitches = Get-LXCARackSwitch</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns a list of all managed rack switches.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Get-LXCAThinkServer</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets inventory data about one or more think servers from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAThinkServer</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAThinkServer cmdlet gets inventory data about one or more think servers from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAThinkServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all ThinkServer servers that are not currently managed. If not specified, this cmdlet returns all managed ThinkServer servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAThinkServer</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of ThinkServer servers. If no UUID is specified, the cmdlet returns all managed ThinkServer servers unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all ThinkServer servers that are not currently managed. If not specified, this cmdlet returns all managed ThinkServer servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Uuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies one or more UUIDs of ThinkServer servers. If no UUID is specified, the cmdlet returns all managed ThinkServer servers unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Unmanaged</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>If specified, the cmdlet returns all ThinkServer servers that are not currently managed. If not specified, this cmdlet returns all managed ThinkServer servers.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe any object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ThinkServer[]</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAThinkServer returns a list of think servers.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$thinkservers = Get-LXCAThinkServer</dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command returns a list of all managed think servers.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> <!-- Start do not translate block --> <command:name>Install-LXCAUpdatePackage</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Applies one or more firmware updates to a target system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Install</command:verb> <command:noun>LXCAUpdatePackage</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Install-LXCAUpdatePackage cmdlet applies one or more firmware updates to a target system based on the results of a compliance policy comparison result for the target system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Install-LXCAUpdatePackage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Compliance</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the system compliance policy comparison result.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemCompliance</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UpdateRule</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies which firmware updates in the compliance policy check result will be applied to target system.</maml:para> <maml:para>- All. All firmware updates in the compliance-check result are applied. To also apply to firmware updates that are in compliance, specify the -ForceUpdate parameter.</maml:para> <maml:para>- NotCompliantOnly. Only firmware that is not compliant will be updated.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ActivationMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart the target system to activate the new firmware.</maml:para> <maml:para>- Immediate. During the update process, the target system might be restarted a number of times automatically until the entire process is complete. Make sure that you quiesce all applications on the target sever before you proceed.</maml:para> <maml:para>- Delayed. Some, but not all update operations are performed. The target system must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>OnErrorMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies how to handle the update error.</maml:para> <maml:para>- StopAllUpdatesOnError. If there is an error in updating any of the components in a system (such as an adapter or IMM firmware), the firmware updates process stops for all selected systems in the current firmware update job. In this case, none of the updates in the firmware updates package for the system will be activated. The current firmware that is installed on all selected systems remains in effect.</maml:para> <maml:para>- ContinueOnError. If there is an error in updating one of the components in the system (such as an adapter or IMM firmware), the firmware updates process does not update the firmware for that specific component. However, the firmware updates process does continue to update the other components for the system and continues with all other updates in the current update job.</maml:para> <maml:para>- ContinueToNextSystemOnError. If there is an error in updating one of the components in a system (such as an adapter or IMM firmware), the firmware updates process stops attempting to update the firmware for that specific system. The current firmware that is installed on that system remains in effect. However, if you have selected multiple systems as part of the current firmware update job, the management server continues to update the firmware for the remaining systems selected as part of the current job.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceUpdate</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Applies the firmware update to the selected endpoints even if the firmware is compliant. Otherwise cmdlet will skip the firmware update on the selected endpoints if the firmware is already compliant.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Simulation</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that it is a simulated update. No updates will actually be applied to the target system.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Install-LXCAUpdatePackage</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Compliance</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the system compliance result.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemCompliance</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FixId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the firmware updates which will be applied to the target system. The value can be component name, component Id or update fix id. Parameter -ForceUpdate is required if you want to apply those compliant firmwares.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ActivationMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart target system to activate new firmware.</maml:para> <maml:para>- Immediate. During the update process, the target system might be restarted a number of times automatically until the entire process is complete. Make sure that you quiesce all applications on the target system before you proceed.</maml:para> <maml:para>- Delayed. Some, but not all update operations are performed. The target system must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>OnErrorMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies how to handle the update error.</maml:para> <maml:para>- StopAllUpdatesOnError. If there is an error in updating any of the components in a system (such as an adapter or IMM firmware), the firmware updates process stops for all selected systems in the current firmware update job. In this case, none of the updates in the firmware updates package for the system will be activated. The current firmware that is installed on all selected systems remains in effect.</maml:para> <maml:para>- ContinueOnError. If there is an error in updating one of the components in the system (such as an adapter or IMM firmware), the firmware updates process does not update the firmware for that specific component. However, the firmware updates process does continue to update the other components for the system and continues with all other updates in the current update job.</maml:para> <maml:para>- ContinueToNextSystemOnError. If there is an error in updating one of the components in a system (such as an adapter or IMM firmware), the firmware updates process stops attempting to update the firmware for that specific system. The current firmware that is installed on that system remains in effect. However, if you have selected multiple systems as part of the current firmware update job, the management server continues to update the firmware for the remaining systems selected as part of the current job.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceUpdate</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Applies the firmware update to the selected endpoints even if the firmware is compliant. Otherwise cmdlet will skip the firmware update on the selected endpoints if the firmware is already compliant.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Simulation</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that it is a simulated update. No updates will actually be applied to the target system.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Compliance</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the system compliance result.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SystemCompliance</command:parameterValue> <dev:type> <maml:name>SystemCompliance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>UpdateRule</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies which firmware updates in the compliance policy check result will be applied to target system.</maml:para> <maml:para>- All. All firmware updates in the compliance-check result are applied. To also apply to firmware updates that are in compliance, specify the -ForceUpdate parameter.</maml:para> <maml:para>- NotCompliantOnly. Only firmware that is not compliant will be updated.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>FixId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the firmware updates which will be applied to the target system. The value can be component name, component Id or update fix id. Parameter -ForceUpdate is required if you want to apply those compliant firmwares.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ActivationMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies when to restart target system to activate new firmware.</maml:para> <maml:para>- Immediate. During the update process, the target system might be restarted a number of times automatically until the entire process is complete. Make sure that you quiesce all applications on the endpoint before you proceed.</maml:para> <maml:para>- Delayed. Some but not all update operations are performed. The target system must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>OnErrorMode</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies how to handle the update error.</maml:para> <maml:para>- StopAllUpdatesOnError. If there is an error in updating any of the components in a system (such as an adapter or IMM firmware), the firmware updates process stops for all selected systems in the current firmware update job. In this case, none of the updates in the firmware updates package for the system will be activated. The current firmware that is installed on all selected systems remains in effect.</maml:para> <maml:para>- ContinueOnError. If there is an error in updating one of the components in the system (such as an adapter or IMM firmware), the firmware updates process does not update the firmware for that specific component. However, the firmware updates process does continue to update the other components for the system and continues with all other updates in the current update job.</maml:para> <maml:para>- ContinueToNextSystemOnError. If there is an error in updating one of the components in a system (such as an adapter or IMM firmware), the firmware updates process stops attempting to update the firmware for that specific system. The current firmware that is installed on that system remains in effect. However, if you have selected multiple systems as part of the current firmware update job, the management server continues to update the firmware for the remaining systems selected as part of the current job.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ForceUpdate</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Applies the firmware update to the selected endpoints even if the firmware is compliant. Otherwise cmdlet will skip the firmware update on the selected endpoints if the firmware is already compliant.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Simulation</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies that it is a simulated update. No updates will actually be applied to the target system.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>AsJob</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>When AsJob is specified, the cmdlet will run as background job and returns a job object immediately.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UpdateResult</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAUpdatePackage returns a UpdateResult object when the AsJob parameter is not used.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Install-LXCAUpdatePackage returns a job object when the AsJob parameter is used. </maml:para> <maml:para>- The UpdateResult can be retrieved from Job.Output when the job is completed.</maml:para> <maml:para>- The SubJob can be retrieved from Job.GetSubJobStatus(), which will include the detail status of each update.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$complianceResult = Get-LXCASystemCompliance -SystemUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -SystemType ComputeNode $updateResult = Install-LXCAUpdatePackage -Compliance $complianceResult -UpdateRule NotCompliantOnly -ActivationMode Immediate -OnErrorMode StopOnError -AsJob </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets a compliance check result from a compute node and then applies all non-compliant firmware updates to that compute node.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$complianceResult = Get-LXCASystemCompliance -SystemUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -SystemType ComputeNode $updateResult = Install-LXCAUpdatePackage -Compliance $complianceResult -FixId $complianceResult.Firmwares[0].ComponentName -ActivationMode Immediate -OnErrorMode StopOnError -ForceUpdate -AsJob </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets a compliance check result from a compute node and then applies a firmware updates to that compute node (in force mode).</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$policy= Get-LXCAUpdateCompliancePolicy -SystemUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -SystemType ComputeNode $complianceResult = Join-LXCAUpdateCompliancePolicy -Policy $policy -SystemUuid BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB -SystemType ComputeNode $job = Install-LXCAUpdatePackage -Compliance $complianceResult -UpdateRule All -ActivationMode Immediate -OnErrorMode StopOnError -ForceUpdate -AsJob while ($job.State -eq "Running") { Start-Sleep -Seconds 5 $job.GetSubJobStatus() } $updateResult = $job.Output </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets a compliance policy from a reference system and assigns it to another system to get the compliance check result. The command then force to apply all available firmware updates to the system, in asynchronous mode.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Join-LXCAUpdateCompliancePolicy</maml:linkText> <maml:linkText>Get-LXCASystemCompliance</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> <!-- Start do not translate block --> <command:name>Get-LXCAInformation</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Gets Lenovo XClarity Administrator server and PowerShell Tool information, including product name, version, and build number.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>Get</command:verb> <command:noun>LXCAInformation</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The Get-LXCAInformation cmdlet gets information about the Lenovo XClarity Administrator server and PowerShell Tool, including product name, version, and build number.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>Get-LXCAInformation</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the default connection is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>LXCAInformation</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAInformation returns an LXCAInformation object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$info = Get-LXCAInformation </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This command gets Lenovo XClarity Administrator server and PowerShell tool version information.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></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> <!-- Start do not translate block --> <command:name>New-LXCADeployTask</command:name> <!-- End do not translate block --> <maml:description> <maml:para>Creates a task for OS deployment, including the target server and other settings that are required during OS deployment. The DeployTask object that is returned by this cmdlet can be used by the Install-LXCAOSImage cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <!-- Start do not translate block --> <command:verb>New</command:verb> <command:noun>LXCADeployTask</command:noun> <dev:version /> <!-- End do not translate block --> </command:details> <maml:description> <maml:para>The New-LXCADeployTask cmdlet creates a task for OS deployment, including the target server and other settings that are required during OS deployment. The DeployTask object that is returned by this cmdlet can be used by the Install-LXCAOSImage cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <!-- Start do not translate block --> <maml:name>New-LXCADeployTask</maml:name> <!-- End do not translate block --> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of target server for OS image deployment. The target server can be retrieved by the Get-LXCADeployableServer cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageProfileID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the OS image profile ID. The OS image ID can be retrieved by the Get-LXCAOSImage cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetDevice</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the device on target node where the OS image will be deployed. Valid values are Localdisk, EmbeddedHypervisor, and SanDisk.</maml:para> <maml:para>- LocalDisk. Use local hard disk storage.</maml:para> <maml:para>- EmbeddedHypervisor. Use embedded hypervisor (USB or SD media adapter) when ESXi is selected. For Lenovo XClarity Administrator v1.0, use usbdisk instead of EmbeddedHypervisor for a USB Embedded Hypervisor when ESXi is selected.</maml:para> <maml:para>- SanDisk. Use SAN volumes if available. The SAN ID is required if the sandisk is selected.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SanID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the SAN ID. It is required if the target device is sandisk. The SAN ID is a string starting from "lunpluswwn=", such as "lunpluswwn=2@50:05:07:68:05:0c:09:bb", where "2" is the LUN and "50:05:07:68:05:0c:09:bb" is the WWN. Make sure to use "@" to join the two strings.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>WindowsDomain</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the domain that the OS will join after it is installed successfully. If there is an OU, the domain should be a string like "domain/ou".</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ADUserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the active directory user name required to join a domain.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ADPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the active directory password required to join a domain.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>LicenseKey</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the license key that is needed for Windows and ESXi OS installation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MacAddress</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the host MAC address to which the IP address will be bound.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IpAddress</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IP address after OS deployment in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SubnetMask</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the subnet mask of the network after OS deployment in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>GateWay</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the gateway of the network after OS deployment, in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DNS1</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the first DNS server of the network after OS deployment in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DNS2</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the second DNS server of the network after OS deployment, in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Mtu</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the MTU (Maximum Transmission Unit) of the network after OS deployment. The default value is 1500. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PrefixLength</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 prefix length after OS deployment. It is required if a static IPv6 was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>VlanId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the VLAN ID for operating-system VLAN tagging. Important: This parameter requires that the VLAN mode setting is enabled in the global settings for operating-system deployment. To change the global settings, use the Set-LXCADeployGlobalSetting cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <!-- End do not translate block --> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Connection</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the results from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ServerUuid</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the UUID of the target server for OS image deployment. The target server can be retrieved using the Get-LXCADeployableServer cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ImageProfileID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the OS image profile ID. The OS image ID can be retrieved using the Get-LXCAOSImage cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>TargetDevice</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the device on target node where the OS image will be deployed. Valid values are Localdisk, EmbeddedHypervisor, and SanDisk.</maml:para> <maml:para>- LocalDisk. Use local hard disk storage.</maml:para> <maml:para>- EmbeddedHypervisor. Use embedded hypervisor (USB or SD media adapter) when ESXi is selected. For Lenovo XClarity Administrator v1.0, use usbdisk instead of EmbeddedHypervisor for a USB Embedded Hypervisor when ESXi is selected.</maml:para> <maml:para>- SanDisk. Use SAN volumes if available. The SAN ID is required if the sandisk is selected.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SanID</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the SAN ID. It is required if the target device is sandisk. The SAN ID is a string starting from "lunpluswwn=", such as "lunpluswwn=2@50:05:07:68:05:0c:09:bb", where "2" is the LUN and "50:05:07:68:05:0c:09:bb" is the WWN. Make sure to use "@" to join the two strings.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>WindowsDomain</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the domain that the OS will join into after it is installed successfully. If there is an OU, the domain should be a string like "domain/ou".</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ADUserName</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the active directory user name required to join a domain.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>ADPassword</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the active directory password required to join a domain.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>LicenseKey</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the license key that is needed for Windows and ESXi OS installation.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>MacAddress</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the host MAC address to which the IP address will be bound.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>IpAddress</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IP address after OS deployment, in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>SubnetMask</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the subnet mask of the network after OS deployment, in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>GateWay</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the gateway of the network after OS deployment, in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DNS1</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the first DNS server of the network after OS deployment, in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>DNS2</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the second DNS server of the network after OS deployment, in an IPv4 format. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>Mtu</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the MTU (Maximum Transmission Unit) of the network after OS deployment. The default value is 1500. It is required if a static IP address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>PrefixLength</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the IPv6 prefix length after OS deployment. It is required if a static IPv6 address was chosen when the global settings were defined.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!-- Start do not translate block --> <maml:name>VlanId</maml:name> <!-- End do not translate block --> <maml:description> <maml:para>Specifies the VLAN ID for operating-system VLAN tagging. Important: This parameter requires that the VLAN mode setting is enabled in the global settings for operating-system deployment. To change the global settings, use the Set-LXCADeployGlobalSetting cmdlet.</maml:para> </maml:description> <!-- Start do not translate block --> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> <!-- End do not translate block --> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <!-- Start do not translate block --> <maml:name>None</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <!-- Start do not translate block --> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployTask</maml:name> <maml:uri/> <!-- End do not translate block --> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>New-LXCADeployTask returns a deploy task object that contains all information for OS deployment. The task can be used by cmdlet Install-LXCAOSImage.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para/> </maml:alert> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <!-- Start do not translate block --> <dev:code>$nodes = Get-LXCADeployableServer $images = Get-LXCAOSImage | where {$_.Name -contains "esxi5.5"} $deploytask = New-LXCADeployTask -ServerUuid $nodes[0].Uuid -ImageProfile $images[0].Profiles[0].Id -TargetDevice "LocalDisk" -MacAddress $nodes[0].HostMacAddresses[0] -IpAddress 9.5.12.122 -SubnetMask 255.255.255.0 -GateWay 9.5.12.1 -DNS1 9.10.244.100 -DNS2 9.10.244.200 -Mtu 1500 Install-LXCAOSImage -DeployTask $deploytask </dev:code> <!-- End do not translate block --> <dev:remarks> <maml:para>This example creates a deploy task and deploy the OS image.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Install-LXCAOSImage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |