en-US/Lenovo.SysMgmt.LXCA.Integration.PowerShell.dll-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <!-- Add-LXCAEventExclusionFilter --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCAEventExclusionFilter</command:name> <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> <command:verb>Add</command:verb> <command:noun>LXCAEventExclusionFilter</command:noun> <dev:version /> </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> <maml:name>Add-LXCAEventExclusionFilter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the exclusion filter. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the exclusion filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUID of target endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the event type. Available values are event and activeAlert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the exclusion filter. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the exclusion filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUID of target endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the event type. Available values are event and activeAlert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.EventExclusionFilter</maml:name> <maml:uri/> <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> <dev:code> Add-LXCAEventExclusionFilter -SourceID AAAAAAAAAAAA -Name "ExclusionFilterOnAAAAAAAAAAAA" -Description "Suppress events from AAAAAAAAAAAA" -Type event </dev:code> <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> <!-- Add-LXCAJobNote --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCAJobNote</command:name> <maml:description> <maml:para> Creates a note and change the state of a specific job (task). </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCAJobNote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet creates a note and change the state of a specific job (task). Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCAJobNote</maml:name> <command:description> Creates a note and change the state of a specific job (task). </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>JobUID</maml:name> <maml:description> <maml:para> Specifies the UID of the job. If the job does not exist, "404 - Not Found" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewState</maml:name> <maml:description> <maml:para> Specifies the new state of the job. You can specify one of the following values: - Aborted - Investigating - Resolved - NoChange </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Text</maml:name> <maml:description> <maml:para> Note text. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>JobUID</maml:name> <maml:description> <maml:para> Specifies the UID of the job. If specified job does not exist, "404 - Not Found" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewState</maml:name> <maml:description> <maml:para> Specifies the new state of the job. You can specify one of the following values: - Aborted - Investigating - Resolved - NoChange </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Text</maml:name> <maml:description> <maml:para> Note text. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet doesn't return any 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> <dev:code> # # The following example add a net to a specific job, keeping the actual job state. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $jobUID = 123444 Add-LXCAJobNote -JobUID $jobUID -NewState NoChange -Text "No Change: waiting for answer..." Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Add-LXCAManagedDevice --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCAManagedDevice</command:name> <maml:description> <maml:para> Manages one or more chassis, rack and tower servers, RackSwitch switches, and Lenovo Storage devices for management with the Lenovo XClarity Administrator server (manages an endpoint). </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCAManagedDevice</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Add-LXCAManagedDevice cmdlet manages one or more chassis, rack and tower servers, RackSwitch switches and Lenovo Storage systems for management with the Lenovo XClarity Administrator server (manages an endpoint). </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name> -----Manages one or more devices by UserName and Password.----- </maml:name> </command:syntaxItem> <!-- ChassisUuid --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <maml:description> <maml:para> Specifies one or more UUIDs of chassis to be managed by the Lenovo XClarity Administrator server. The chassis must have been already discovered. Tip: Use the Get-LXCAChassis -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed chassis. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryPassword</maml:name> <maml:description> <maml:para> Specifies the password for RECOVERY_ID user. 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. When you manage a System X or NeXtScale server, the IMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local IMM user accounts are no longer valid. You can use the RECOVERY_ID to access the IMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify for RecoveryPassword and store it in a secure location. </maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <!-- RackServerUuid --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <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 been already discovered. Tip: Use the Get-LXCARackServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed System x servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryPassword</maml:name> <maml:description> <maml:para> Specifies the password for the RECOVERY_ID user. 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. When you manage a System X or NeXtScale server, the IMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local IMM user accounts are no longer valid. You can use the RECOVERY_ID to access the IMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify for RecoveryPassword and store it in a secure location. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <!-- ThinkServerUuid --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <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 been already 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> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <!-- StorageUuid --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para> Specifies one or more UUIDs for Lenovo Storage systems to be managed by the Lenovo XClarity Administrator server. The storage system must have been already discovered. Tip: Use the Get-LXCAStorage -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed Lenovo Storage systems. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <!-- IpAddress --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>IpAddress</maml:name> <maml:description> <maml:para>Specifies one or more IPv4 and IPv6 addresses of chassis, System x servers, ThinkServer servers and Lenovo Storages be managed by the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryPassword</maml:name> <maml:description> <maml:para> Specifies the recovery ID password. 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. When you manage a System X or NeXtScale server, the IMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local IMM user accounts are no longer valid. You can use the RECOVERY_ID to access the IMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify for RecoveryPassword and store it in a secure location. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <!-- FQDN --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>FQDN</maml:name> <maml:description> <maml:para> Specifies one or more FQDN addresses of chassis, System x servers, ThinkServer servers and Lenovo Storages be managed by the Lenovo XClarity Administrator server. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryPassword</maml:name> <maml:description> <maml:para> Specifies the password for the RECOVERY_ID user. 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. When you manage a System X or NeXtScale server, the IMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local IMM user accounts are no longer valid. You can use the RECOVERY_ID to access the IMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify for RecoveryPassword and store it in a secure location. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <!-- IPv4Range --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>IPv4Range</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryPassword</maml:name> <maml:description> <maml:para> Specifies the password for the RECOVERY_ID user. 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. When you manage a System X or NeXtScale server, the IMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local IMM user accounts are no longer valid. You can use the RECOVERY_ID to access the IMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify for RecoveryPassword and store it in a secure location. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <!-- BulkImportFile --> <command:syntaxItem> <maml:name>Add-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>BulkImportFile</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentRackServerUserName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentRackServerPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewRackServerPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentChassisUserName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentChassisPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewChassisPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryPassword</maml:name> <maml:description> <maml:para> Specifies the password for the RECOVERY_ID user. 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. When you manage a System X or NeXtScale server, the IMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local IMM user accounts are no longer valid. You can use the RECOVERY_ID to access the IMM directly if there are issues with the Lenovo XClarity Administrator server. Ensure that you write down the password that you specify for RecoveryPassword and store it in a secure location. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentStorageUserName</maml:name> <maml:description> <maml:para> Specifies the user account for the Lenovo Storage system 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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentStoragePassword</maml:name> <maml:description> <maml:para> Specifies the password for the user account that is specified using the -CurrentStorageUserName parameter. This password is used if a password is not defined in the bulk-import file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentSwitchUserName</maml:name> <maml:description> <maml:para> Specifies the user account for the RackSwitch switch 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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentSwitchPassword</maml:name> <maml:description> <maml:para> Specifies the password for the user account that is specified using the -CurrentSwitchUserName parameter. This password is used if a password is not defined in the bulk-import file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SwitchEnablePassword</maml:name> <maml:description> <maml:para> Specifies the password to enable Privileged Exec Mode, if the switch requires it. This password is used if a password is not defined in the bulk-import file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ServerStoredCredentialsId</maml:name> <maml:description> <maml:para> Specifies the stored credentials for all servers if you specify the -BulkImportFile parameter. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisStoredCredentialsId</maml:name> <maml:description> <maml:para> Specifies the stored credentials for all chassis and chassis devices if you specify the -BulkImportFile parameter file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisableManagedAuth</maml:name> <maml:description> <maml:para> When specified, without using centralized management, If not specified, using centralized management. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <maml:description> <maml:para> Specifies one or more UUIDs of chassis to be managed by the Lenovo XClarity Administrator server. The chassis must have been already discovered. Tip: Use the Get-LXCAChassis -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed chassis. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <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 been already discovered. Tip: Use the Get-LXCARackServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed System x servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <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 been already 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> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para> Specifies one or more UUIDs for Lenovo Storage systems to be managed by the Lenovo XClarity Administrator server. The storage system must have been already discovered. Tip: Use the Get-LXCAStorage -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed Lenovo Storage systems. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IpAddress</maml:name> <maml:description> <maml:para> Specifies one or more IPv4 and IPv6 addresses of chassis, System x servers, ThinkServer servers and Lenovo Storages be managed by the Lenovo XClarity Administrator server. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FQDN</maml:name> <maml:description> <maml:para> Specifies one or more FQDN addresses of chassis, System x servers, ThinkServer servers and Lenovo Storages be managed by the Lenovo XClarity Administrator server. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>IPv4Range</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Username</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryPassword</maml:name> <maml:description> <maml:para> Specifies the password for the RECOVERY_ID user. When you manage a chassis, the CMM is configured to authenticate users with Lenovo XClarity Administrator. Local CMM user accounts are no longer valid. You can use the RECOVERY_ID to access the CMM directly if there are issues with Lenovo XClarity Administrator. The parameter is required if managed endpoint is a CMM. When you manage a System x or NeXtScale server, the IMM is configured to authenticate users with the Lenovo XClarity Administrator server. Local IMM user accounts are no longer valid. You can use the RECOVERY_ID to access the IMM 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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>BulkImportFile</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentRackServerUserName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentRackServerPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewRackServerPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentChassisUserName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentChassisPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewChassisPassword</maml:name> <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> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentStorageUserName</maml:name> <maml:description> <maml:para> Specifies the user account for the Lenovo Storage system 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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentStoragePassword</maml:name> <maml:description> <maml:para> Specifies the password for the user account that is specified using the -CurrentStorageUserName parameter. This password is used if a password is not defined in the bulk-import file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentSwitchUserName</maml:name> <maml:description> <maml:para> Specifies the user account for the RackSwitch switch 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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentSwitchPassword</maml:name> <maml:description> <maml:para> Specifies the password for the user account that is specified using the -CurrentSwitchUserName parameter. This password is used if a password is not defined in the bulk-import file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SwitchEnablePassword</maml:name> <maml:description> <maml:para> Specifies the password to enable Privileged Exec Mode, if the switch requires it. This password is used if a password is not defined in the bulk-import file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceManage</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StoredCredentialId</maml:name> <maml:description> <maml:para> Specifies the stored credential to use for this managed device. If you specify -DisableManageAuth, you must specify a stored credential to manage the endpoint; otherwise, you must specify either -Username or -StoredCredentialId, but not both. Tip: Use the Get-LXCAStoredCredential cmdlet to retrieve stored credential id. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>DisableManagedAuth</maml:name> <maml:description> <maml:para> If specified, endpoints are managed using local authentication. If not specified, endpoints are managed using Lenovo XClarity Administrator managed authentication. Note: - Managed and local authentication are not supported for ThinkServer and System x M4 servers. - Managed authentication is not supported for rack switch, this option will be ignored when manage rack switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ManageDeviceResult</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ChassisManageResult</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackServerManageResult</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ThinkServerManageResult</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.StorageManageResult</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCAManagedDevice returns a StorageManageResult object when parameter StorageUuid is specified.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackSwitchManageResult</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <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:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:remarks> <maml:para /> </dev:remarks> <dev:code> # # This command gets retrieves all chassis that have been discovered but that are currently unmanaged and then manages those chassis using managed authentication. # $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 -RecoveryPassword $recoveryPwd } </dev:code> <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> <dev:code> # # This command manages an undiscovered chassis as a job that runs in the background and wait until the job is finished. # $password = ConvertTo-SecureString "Password" -AsPlainText –Force $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText –Force $job = Add-LXCAManagedDevice -IpAddress 1.111.11.11 -Username USERID -Password $password -RecoveryPassword $recoveryPwd -AsJob while($job.State -eq "Running") { Start-Sleep -Seconds 5 } </dev:code> <dev:remarks> <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> <dev:code> # # This command manages multiple endpoints using an IPv4 address range. # $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 -RecoveryPassword $recoveryPwd </dev:code> <dev:remarks> <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> <dev:code> # # This command uses a bulk-import file to manage multiple endpoints. # $password = ConvertTo-SecureString "Password" -AsPlainText –Force Add-LXCAManagedDevice -BulkImportFile c:\buikimport.csv -CurrentRackServerUsername USERID -CurrentRackServerPassword $password </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> # # This command retrieves all chassis that have been discovered but that are currently unmanaged and then manages those chassis using local authentication. # $unmanagedchassis = Get-LXCAChassis -Unmanaged $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText –Force foreach ($chassis in $unmanagedchassis) { Add-LXCAManagedDevice -ChassisUuid $chassis.uuid -StoredCredentialId $SCId -RecoveryPassword $recoveryPwd -DisableManagedAuth } </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> # # This command adds an undiscovered chassis as a job that runs in the background and wait until the job is finished. # When 'DisableManagedAuth' is specified the chassis is managed using local authentication. # If 'DisableManagedAuth' is not specified, endpoints are managed using Lenovo XClarity Administrator managed # $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText –Force $job = Add-LXCAManagedDevice -IpAddress 1.111.11.11 -StoredCredentialId $SCId -RecoveryPassword $recoveryPwd -AsJob [-DisableManagedAuth] while($job.State -eq "Running") { Start-Sleep -Seconds 5 } </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> # # This command manages multiple endpoints using an IPv4 address range. # When 'DisableManagedAuth' is specified the chassis is managed using local authentication. # If 'DisableManagedAuth' is not specified, endpoints are managed using Lenovo XClarity Administrator managed # $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText –Force Add-LXCAManagedDevice -Ipv4Range 1.111.11.11-1.111.11.20 -StoredCredentialId $SCId -RecoveryPassword $recoveryPwd [-DisableManagedAuth] </dev:code> <dev:remarks> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> # # This command manages server using an uuid. # When 'DisableManagedAuth' is specified the chassis is managed using local authentication. # If 'DisableManagedAuth' is not specified, endpoints are managed using Lenovo XClarity Administrator managed # Add-LXCAManagedDevice -RackServerUuid $uuid -StoredCredentialId $scId -ForceManage -AsJob [-DisableManagedAuth] </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 9 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This command uses a bulk import file to management multiple devices using a stored credential and managed authentication. # When 'DisableManagedAuth' is specified the chassis is managed using local authentication. # If 'DisableManagedAuth' is not specified, endpoints are managed using Lenovo XClarity Administrator managed # Add-LXCAManagedDevice -BulkImportFile c:\buikimport.csv -ServerStoredCredentialsId $scId [-DisableManagedAuth] </dev:code> <dev:remarks> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 10 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This command uses a bulk import file to management multiple devices using a stored credential. # $rpwd = ConvertTo-SecureString "PASSW0RD!" -AsPlainText –Force Add-LXCAManagedDevice -BulkImportFile c:\buikimport.csv -ChassisStoredCredentialsId $scId -RecoveryPassword $rpwd </dev:code> <dev:remarks> <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> <!-- Add-LXCAPSLogHeader --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCAPSLogHeader</command:name> <maml:description> <maml:para> Write a user message in PS log file. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCAPSLogHeader</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet writes, as header, a user message in PS log file. Can be used to mark the start and/or the end of a block in a script. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCAPSLogHeader</maml:name> <command:description> This cmdlet writes a message in PS log file. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserMessage</maml:name> <maml:description> <maml:para> Specifies the message in the header that the user wants to add in PS log file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MachineId</maml:name> <maml:description> <maml:para> If used, the machine identity (machine name) is added in the header that will be written in PS log file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Identity</maml:name> <maml:description> <maml:para> If used, the user identity (user name and domain if is the case) is added in the header that will be written in PS log file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserMessage</maml:name> <maml:description> <maml:para> Specifies the message in the header that the user wants to add in PS log file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MachineId</maml:name> <maml:description> <maml:para> If used, the machine identity (machine name) is added in the header that will be written in PS log file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Identity</maml:name> <maml:description> <maml:para> If used, the user identity (user name and domain if is the case) is added in the header that will be written in PS log file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet doesn't return any 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> <dev:code> # # The follwing example writes a full message header in PS log file. # UserMessage contains the full name of the current script. Add-LXCAPSLogHeader -Identity -MachineId -UserMessage "Starting '$PSCommandPath'" </dev:code> <dev:remarks> <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> <!-- Add-LXCARack --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCARack</command:name> <maml:description> <maml:para>This cmdlet creates a new rack instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCARack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet creates a new rack instance. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCARack</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of rack. The name must be unique and have the length between 1 and 256 characters. Allowed characters for the rack name are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Height</maml:name> <maml:description> <maml:para> Specifies the height of the rack in rack units. The available values are 6, 12, 18, 25, 37, 42, 45, 46, 48, 50, 52. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the location of the rack. The location should have the length between 1 and 256 characters. Allowed characters for the rack location are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Room</maml:name> <maml:description> <maml:para> Specifies the room where the rack is located. The room should have the length between 1 and 256 characters. Allowed characters for the rack room are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of rack. The name must be unique and have the length between 1 and 256 characters. Allowed characters for the rack name are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Height</maml:name> <maml:description> <maml:para> Specifies the height of the rack in rack units. The available values are 6, 12, 18, 25, 37, 42, 45, 46, 48, 50, 52. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the location of the rack. The location should have the length between 1 and 256 characters. Allowed characters for the rack location are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Room</maml:name> <maml:description> <maml:para> Specifies the room where the rack is located. The room should have the length between 1 and 256 characters. Allowed characters for the rack room are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Rack</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.Rack object with details about the newly created rack.</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> <dev:code> # # The following creates a rack. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $rack = Add-LXCARack -Name MyRack -Height 42 -Location Lab-1 -Room 101 # show rack data. $rack Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Add-LXCARackItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCARackItem</command:name> <maml:description> <maml:para> This cmdlet adds a managed device to a rack. The managed device can be a chassis, System x server, ThinkServer server, a scalable complex system, or a filler. The rack location information is applied to the specified device. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCARackItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet adds a managed device to a rack. The managed device can be a chassis, System x server, ThinkServer server, a scalable complex system, or a filler. The rack location information is applied to the specified device. Note: You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCARackItem</maml:name> <command:description> Add a managed chassis to this rack. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed device to be added to the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device. The name is displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Chassis</maml:name> <maml:description> <maml:para>Specifies that managed device item to be added is a chassis.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCARackItem</maml:name> <command:description> Add a managed server to this rack: System X, ThinkServer. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed device to be added to the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device. The name is displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a System x or ThinkServer server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCARackItem</maml:name> <command:description> Add a managed switch to this rack. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed device to be added to the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device. The name is displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Switch</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a top-of-rack switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCARackItem</maml:name> <command:description> Add a managed storage to this rack. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed device to be added to the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device. The name is displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a storage node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCARackItem</maml:name> <command:description> Add a managed Complex System to this rack. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexSystemId</maml:name> <maml:description> <maml:para>Specifies the ID of a scalable complex system to be added to the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexSystem</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a scalable-complex system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCARackItem</maml:name> <command:description> Add a general placeholder to this rack. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device. The name is displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemHeight</maml:name> <maml:description> <maml:para>Specifies the height of the managed device in rack units.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Placeholder</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a filler.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCARackItem</maml:name> <command:description> Add a specific placeholder to this rack. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device. The name is displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PlaceholderType</maml:name> <maml:description> <maml:para> Indicates the type of the placeholder to add in rack. You can specify one of the following values: - 1U_Filler; - 2U_Filler; - 4U_Filler; - 3U_PureStorage; - IBM_Storwize_Control_Enclosure; - IBM_Storwize_Expansion_Enclosure; - Lenovo_RackSwitch; - Juniper_RackSwitch; - Lenovo_B300_FC_SAN_Switch; - Lenovo_6505_FC_SAN_Switch; - Lenovo_6510_FC_SAN_Switch; - ThinkSystem_DB610S_32Gb_FC_SAN_Switch; - ThinkSystem_DB620S_32Gb_FC_SAN_Switch; - ThinkSystem_DB400D_32Gb_FC_SAN_Director; - ThinkSystem_DB800D_32Gb_FC_SAN_Director; - 2U_Lenovo_Storage_Controller_Enclosure; - 2U_Lenovo_Storage_Expansion_Enclosure; - 4U_Nimble_Storage_Expansion_Enclosure; - 2U_NetApp_FAS_Disk_Shelf; - 2U_NetApp_FAS_Controller; - 3U_NetApp_FAS_Controller; - 4U_NetApp_FAS_Disk_Shelf; - 4U_NetApp_FAS_Controller; - 6U_NetApp_FAS_Controller; - 1U_EMC_VNX_Standbay_Power_Supply; - 1U_EMC_VNX_Control_Station; - 2U_EMC_VNX_Data_Mover_Enclosure; - 2U_EMC_VNX_Disk_Array_Enclosure; - 2U_EMC_VNX_Disk_Processor_Enclosure; - 2U_EMC_VNX_Standby_Power_Supply; - 2U_EMC_VNX_Storage_Processor_Enclosure; - 3U_EMC_VNX_Disk_Array_Enclosure; - 3U_EMC_VNX_Disk_Processor_Enclosure; - 4U_EMC_VNX_Disk_Array_Enclosure; - 4U_EMC_VNX_Storage_Processor_Enclosure. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed device to be added to the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexSystemId</maml:name> <maml:description> <maml:para>Specifies the ID of a scalable complex system to be added to the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device. The name is displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemHeight</maml:name> <maml:description> <maml:para>Specifies the height of the managed device in rack units.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Chassis</maml:name> <maml:description> <maml:para>Specifies that managed device item to be added is a chassis.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a System x or ThinkServer server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Switch</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a top-of-rack switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a storage node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexSystem</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a scalable-complex system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Placeholder</maml:name> <maml:description> <maml:para>Specifies that the managed device to be added is a filler.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PlaceholderType</maml:name> <maml:description> <maml:para> Indicates the type of the placeholder to add in rack. You can specify one of the following values: - 1U_Filler; - 2U_Filler; - 4U_Filler; - 3U_PureStorage; - IBM_Storwize_Control_Enclosure; - IBM_Storwize_Expansion_Enclosure; - Lenovo_RackSwitch; - Juniper_RackSwitch; - Lenovo_B300_FC_SAN_Switch; - Lenovo_6505_FC_SAN_Switch; - Lenovo_6510_FC_SAN_Switch; - ThinkSystem_DB610S_32Gb_FC_SAN_Switch; - ThinkSystem_DB620S_32Gb_FC_SAN_Switch; - ThinkSystem_DB400D_32Gb_FC_SAN_Director; - ThinkSystem_DB800D_32Gb_FC_SAN_Director; - 2U_Lenovo_Storage_Controller_Enclosure; - 2U_Lenovo_Storage_Expansion_Enclosure; - 4U_Nimble_Storage_Expansion_Enclosure; - 2U_NetApp_FAS_Disk_Shelf; - 2U_NetApp_FAS_Controller; - 3U_NetApp_FAS_Controller; - 4U_NetApp_FAS_Disk_Shelf; - 4U_NetApp_FAS_Controller; - 6U_NetApp_FAS_Controller; - 1U_EMC_VNX_Standbay_Power_Supply; - 1U_EMC_VNX_Control_Station; - 2U_EMC_VNX_Data_Mover_Enclosure; - 2U_EMC_VNX_Disk_Array_Enclosure; - 2U_EMC_VNX_Disk_Processor_Enclosure; - 2U_EMC_VNX_Standby_Power_Supply; - 2U_EMC_VNX_Storage_Processor_Enclosure; - 3U_EMC_VNX_Disk_Array_Enclosure; - 3U_EMC_VNX_Disk_Processor_Enclosure; - 4U_EMC_VNX_Disk_Array_Enclosure; - 4U_EMC_VNX_Storage_Processor_Enclosure. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Add-LXCARackItem 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> <dev:code> # # This command adds a system x server with UUID BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB into the rack with UUID EEEEEEEE-1111-2222-3333-FFFFFFFFFFFF. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Add-LXCARackItem -RackUuid "EEEEEEEE-1111-2222-3333-FFFFFFFFFFFF" -Server -ItemUuid "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB" -ItemLowestRackUnit 10 #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This command adds a generic placeholder into the rack with UUID EEEEEEEE-1111-2222-3333-FFFFFFFFFFFF. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Add-LXCARackItem -RackUuid "EEEEEEEE-1111-2222-3333-FFFFFFFFFFFF" -Placeholder -ItemName "Switch_to_add" -ItemLowestRackUnit 19 -ItemHeight 1 #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This command adds a 'ThinkSystem DB800D 32Gb FC SAN Director' placeholder into the rack with UUID EEEEEEEE-1111-2222-3333-FFFFFFFFFFFF. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Add-LXCARackItem -RackUuid "EEEEEEEE-1111-2222-3333-FFFFFFFFFFFF" -PlaceholderType ThinkSystem_DB800D_32Gb_FC_SAN_Director -ItemName "DB800D_SAN_Director_to_add" -ItemLowestRackUnit 20 #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Add-LXCAResourceGroupMembers --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCAResourceGroupMembers</command:name> <maml:description> <maml:para> This cmdlet add devices to a static resource group. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCAResourceGroupMembers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet add devices to a static resource group. Note: You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCAResourceGroupMembers</maml:name> <command:description> This cmdlet add devices to a static resource group. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para> Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupUuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the resource group to which you want to add devices. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeviceType</maml:name> <maml:description> <maml:para> Specifies the Type of the devices to be added. You can specify one of the following values: - Chassis; - Nodes; - Switches; - Storage; </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DevicesUuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the devices to be added. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para> Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupUuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the resource group to which you want to add devices. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeviceType</maml:name> <maml:description> <maml:para> Specifies the Type of the devices to be added. You can specify one of the following values: - Chassis; - Nodes; - Switches; - Storage; </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DevicesUuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the devices to be added. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ResourceGroup</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.ResourceGroup object for the resource group with specified UUID. The returned object contains all the devices (including devices that were just added) in the resource group. Note: This cmdlet does not returns any error if one or more devices were not added to the group. </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> <dev:code> # # The following example adds 3 switches to a specific resource group. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $groupUuid = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" $switchesUuids = @("EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE", "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC") $result = Add-LXCAResourceGroupMembers -GroupUuid $groupUuid -DevicesUuid $switchesUuids -DeviceType Switches $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Add-LXCARoleGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCARoleGroup</command:name> <maml:description> <maml:para>This cmdlet to create a new role group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCARoleGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet creates a new role group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCARoleGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupName</maml:name> <maml:description> <maml:para>Specifies the name of group. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleList</maml:name> <maml:description> <maml:para>Specifies the role list of group. The RoleList must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserList</maml:name> <maml:description> <maml:para>Specifies the user list of the role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupName</maml:name> <maml:description> <maml:para>Specifies the name of group. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleList</maml:name> <maml:description> <maml:para>Specifies the role list of group. The RoleList must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserList</maml:name> <maml:description> <maml:para>Specifies the user list of the role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns result message.</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> <dev:code> $role = Get-LXCARole $user = Get-LXCAUserAccount -GetUserName Add-LXCARoleGroup -RoleGroupName $name -RoleList $role[0],$role[2] -Description $desc -UserList $user[0],$user[1] </dev:code> <dev:remarks> <maml:para>This command creates a new role group instance.</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-LXCARole</maml:linkText> <maml:linkText>Get-LXCAUserAccount</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Add-LXCAStoredCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCAStoredCredential</command:name> <maml:description> <maml:para> This cmdlet creates a stored credential in the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCAStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet creates a stored credential in the Lenovo XClarity Administrator server. There are two types of stored credentials: management and recovery. When you create a recovery stored credential, RECOVERY_ID is used as the user name. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCAStoredCredential</maml:name> <command:description> Add a Management StoredCredential in the Lenovo XClarity Administrator. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para> Specifies the user ID of the new stored credential. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para> Specifies the password of the new stored credential. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para> Specifies the description of the new stored credential. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCAStoredCredential</maml:name> <command:description> Add a Recovery StoredCredential in the Lenovo XClarity Administrator. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para> Specifies the password of the new stored credential. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para> Specifies the description of the new stored credential. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryCredential</maml:name> <maml:description> <maml:para> Indicates that the stored credential that is designated for recovery purposes. In this case, credential’s UserName is always RECOVERY_ID. If not specified, the stored credential that is designated for management purposes. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para> Specifies the user ID of the new stored credential. Note: - the UserName value is ignored and RECOVERY_ID is used when stored credential's type is 'Recovery'. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para> Specifies the password of the new stored credential. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para> Specifies the description of the new stored credential. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RecoveryCredential</maml:name> <maml:description> <maml:para> Indicates that the stored credential that is designated for recovery purposes. In this case, credential’s UserName is always RECOVERY_ID. If not specified, the stored credential that is designated for management purposes. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.StoredCredentialData</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a StoredCredentialData object. StoredCredentialData.IsValid can be used to verify if the StoredCredential was successfuly created on the Lenovo XClarity Administrator. </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> <dev:code> # # The following example creates a stored credential of Management type. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $pwd = ConvertTo-SecureString "password" -AsPlainText -Force $account = Add-LXCAStoredCredential -UserName USERID1 -Password $pwd Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example creates a stored credential of Recovery type. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $pwd = ConvertTo-SecureString "password" -AsPlainText -Force $account = Add-LXCAStoredCredential -Password $pwd -RecoveryCredential Disconnect-LXCA </dev:code> <dev:remarks> <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-LXCAStoredCredential</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Add-LXCAUserAccount --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-LXCAUserAccount</command:name> <maml:description> <maml:para>Adds an Lenovo XClarity Administrator user account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> </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> <maml:name>Add-LXCAUserAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user ID of the new user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password of the new user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroups</maml:name> <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_RECOVERY. 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. These users can also authenticate directly to the Lenovo XClarity Administrator even if the authentication method is set to external LDAP server. This role provides a recovery mechanism in case a communication error occurs with the external LDAP server that uses the "Login Credentials" configuration. 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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PasswordChangeFirstAccess</maml:name> <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> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user ID of the new user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password of the new user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroups</maml:name> <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_RECOVERY. 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. These users can also authenticate directly to the Lenovo XClarity Administrator even if the authentication method is set to external LDAP server. This role provides a recovery mechanism in case a communication error occurs with the external LDAP server that uses the "Login Credentials" configuration. 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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PasswordChangeFirstAccess</maml:name> <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> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <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> <dev:code> $pwd = ConvertTo-SecureString "password" -AsPlainText –Force $account = Add-LXCAUserAccount -UserName USERID1 -Password $pwd -RoleGroups LXC-SUPERVISOR,LXC-ADMIN -PasswordChangeFirstAccess $true </dev:code> <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> <!-- Backup-LXCA --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Backup-LXCA</command:name> <maml:description> <maml:para> Use this cmdlet to backup a Lenovo XClarity Administrator system data, settings, and imported files such as operating-system images, firmware updates, and OS device drivers. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Backup</command:verb> <command:noun>LXCA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> Use this cmdlet to backup a Lenovo XClarity Administrator system data, settings, and imported files such as operating-system images, firmware updates, and OS device drivers. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Backup-LXCA</maml:name> <command:description> Use this cmdlet to backup a Lenovo XClarity Administrator system data, settings, and imported files such as operating-system images, firmware updates, and OS device drivers. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Label</maml:name> <maml:description> <maml:para> The name of the backup; </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para> Passphrase that is required for decrypting and restoring the backup. Note: - If you forget the passphrase, it cannot be recovered. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RemoteShareDestination</maml:name> <maml:description> <maml:para> The remote share location where the backup will be created. If not specified, the backup will be created in the LXCA's internal repository. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeOS</maml:name> <maml:description> <maml:para> If specified, the backup will include operating system images. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeFirmware</maml:name> <maml:description> <maml:para> If specified, the backup will include firmware and OS device-driver updates in the backup. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Label</maml:name> <maml:description> <maml:para> The name of the backup; </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para> Passphrase that is required for decrypting and restoring the backup. Note: - If you forget the passphrase, it cannot be recovered. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RemoteShareDestination</maml:name> <maml:description> <maml:para> The remote share location where the backup will created. If not specified, the backup will be created in the LXCA's internal repository. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeOS</maml:name> <maml:description> <maml:para> If specified, the backup will include operating system images. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeFirmware</maml:name> <maml:description> <maml:para> If specified, the backup will include firmware and OS device-driver updates in the backup. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCABackupResult</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.LXCABackupResult object which contains information about the backup process result. If the backup process succeeds, the backup id is also returned. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # The following example creates a full backup (OS images and firmware/updates are included). $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $backupPwd = ConvertTo-SecureString "password" -AsPlainText -Force $result Backup-LXCA -Label backupLabel -Password $backupPwd -IncludeFirmware -IncludeOS # show all the information about the request: # - Result value, # - Message if any, # - backup id (if available - backup completyed successfuly). $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Backup-LXCAEventLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Backup-LXCAEventLog</command:name> <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> <command:verb>Backup</command:verb> <command:noun>LXCAEventLog</command:noun> <dev:version /> </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> <maml:name>Backup-LXCAEventLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the event type. Available values are All, EventLog, and AuditLog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the starting event sequence number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of events that are to be returned from the starting sequence number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the file name to which the events is to be appended.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoHead</maml:name> <maml:description> <maml:para>If specified, the cmdlet is not saves the CSV header to the local file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the event type. Available values are All, EventLog, and AuditLog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the starting event sequence number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of events that are to be returned from the starting sequence number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the file name to which the events is to be appended.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoHead</maml:name> <maml:description> <maml:para>If specified, the cmdlet is not saves the CSV header to the local file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.BackupEventResult</maml:name> <maml:uri/> <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> <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> <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> <!-- Backup-LXCASwitchConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Backup-LXCASwitchConfig</command:name> <maml:description> <maml:para> This cmdlet backs up configuration data for a RackSwitch or Flex System switch. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Backup</command:verb> <command:noun>LXCASwitchConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet backs up configuration data for a RackSwitch or Flex System switch. When backing up configuration data, the switch configuration data is imported into Lenovo XClarity Administrator from the target switch as a configuration-data file. Note: You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Backup-LXCASwitchConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data file </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switches to be backed up. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para> Specifies the description of the configuration-data file. If a description is not specified, a default text is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switches to be backed up. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para> Specifies the description of the configuration-data file. If a description is not specified, a default text is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns a string with result of the backup operation.</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> <dev:code> # # The following example backs up configuration data for a specific switch to a file name Switch1.cfg # and show the operation result. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Backup-XCASwitchConfig -UUID AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -FileName Switch1.cfg -Description "Switch1 configuration") #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Connect-LXCA --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-LXCA</command:name> <maml:description> <maml:para>Connects to the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>LXCA</command:noun> <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> <maml:name>Connect-LXCA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Host</maml:name> <maml:description> <maml:para>Specifies the Lenovo XClarity Administrator server HTTPS address (IP address or host name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Proxy</maml:name> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>Credential</maml:name> <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> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>Timeout</maml:name> <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> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>SkipCertificateCheck</maml:name> <maml:description> <maml:para>If -SkipCertificateCheck is specified, the cmdlet will skip the server certificate checking.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Host</maml:name> <maml:description> <maml:para>Specifies the Lenovo XClarity Administrator server HTTPS address (IP address or host name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>Proxy</maml:name> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> <dev:type> <maml:name>WebProxy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Credential</maml:name> <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> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>Timeout</maml:name> <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> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <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> <dev:code> $cred = Get-Credential $connection = Connect-LXCA -Host 1.111.11.11 -Credential $cred </dev:code> <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> <maml:linkText>Disconnect-LXCA</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Disconnect-LXCA --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-LXCA</command:name> <maml:description> <maml:para>Disconnects from Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>LXCA</command:noun> <dev:version /> </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> <maml:name>Disconnect-LXCA</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> $cred = Get-Credential Connect-LXCA -Host 1.111.11.11 -Credential $cred #Other actions Disconnect-LXCA </dev:code> <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> <maml:linkText>Connect-LXCA</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Get-LXCAActiveAlert --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAActiveAlert</command:name> <maml:description> <maml:para>Gets active alerts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAActiveAlert</command:noun> <dev:version /> </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> <maml:name>Get-LXCAActiveAlert</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComponentID</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which alerts apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAActiveAlert</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComponentID</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which alerts apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ActiveAlert[]</maml:name> <maml:uri/> <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> <dev:code> $alerts = Get-LXCAActiveAlert </dev:code> <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> <dev:code> $alerts = Get-LXCAActiveAlert -Severity Critical,Fatal -EventClass Blade </dev:code> <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> <!-- Get-LXCAActiveSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAActiveSession</command:name> <maml:description> <maml:para>Gets currently active user sessions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAActiveSession</command:noun> <dev:version /> </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> <maml:name>Get-LXCAActiveSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ActiveSession[]</maml:name> <maml:uri/> <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> <dev:code> $sessions = Get-LXCAActiveSession </dev:code> <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> <!-- Get-LXCAActiveStatus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAActiveStatus</command:name> <maml:description> <maml:para>Gets the current status for a managed endpoint.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAActiveStatus</command:noun> <dev:version /> </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> <maml:name>Get-LXCAActiveStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComponentID</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which the status applies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAActiveStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComponentID</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of the components to which the status applies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ActiveStatus[]</maml:name> <maml:uri/> <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> <dev:code> $status = Get-LXCAActiveStatus </dev:code> <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> <dev:code> $status = Get-LXCAActiveStatus -Severity Critical,Fatal </dev:code> <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> <!-- Get-LXCAAuditLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAAuditLog</command:name> <maml:description> <maml:para>Gets the audit log from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAAuditLog</command:noun> <dev:version /> </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> <maml:name>Get-LXCAAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PreviousHours</maml:name> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining log entries.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EndSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PreviousHours</maml:name> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining log entries.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EndSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.AuditLog[]</maml:name> <maml:uri/> <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> <dev:code> $audit = Get-LXCAAuditLog </dev:code> <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> <dev:code> $audit = Get-LXCAAuditLog -Severity Critical,Fatal -PreviousHours 12 </dev:code> <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> <!-- Get-LXCAAvailableMachineType --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAAvailableMachineType</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAAvailableMachineType</command:noun> <dev:version /> </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> <maml:name>Get-LXCAAvailableMachineType</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.MachineType[]</maml:name> <maml:uri/> <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> <dev:code> $mts = Get-LXCAAvailableMachineType </dev:code> <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> <!-- Get-LXCABackups --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCABackups</command:name> <maml:description> <maml:para> Use this cmdlet to retrieve information about all Lenovo XClarity Administrator backups or export (download) a Lenovo XClarity Administrator backup (.tar file) to the local system. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCABackups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> Use this cmdlet to retrieve information about all Lenovo XClarity Administrator backups or export (download) a Lenovo XClarity Administrator backup (.tar file) to the local system. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCABackups</maml:name> <command:description> Retrieve information about all Lenovo XClarity Administrator backups. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCABackups</maml:name> <command:description> Export (download) a Lenovo XClarity Administrator backup (.tar file) to the local system. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> UUID of the backup to be downloaded. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the directory and file name where the file is to be saved on the local system. - If you specify a directory but not a file name (in other words, if the string ends with a back slash "\"), the file name that is returned by the XClarity Administrator is used. - If the directory does not exist, it is automatically created. - If you specify a string that does not end with a backslash "\", the name after the last backslash "\" is used as the file name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The _full_file_path_ file already exists exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the directory and file name where the file is to be saved on the local system. - If you specify a directory but not a file name (in other words, if the string ends with a back slash "\"), the file name that is returned by the XClarity Administrator is used. - If the directory does not exist, it is automatically created. - If you specify a string that does not end with a backslash "\", the name after the last backslash "\" is used as the file name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">system.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The _full_file_path_ file already exists exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> UUID of the backup to be downloaded. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAFileDownloadResult</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> When -Uuid parameter is specified, this cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.LXCAFileDownloadResult object, which contains the information about the export of the backup file. If the export process succeeds, the path of the downloaded file is also returned. </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCABackupsInfo</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.LXCABackupsInfo object that contains information about all the existing backups on the Lenovo XClarity Administrator server. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # The following example retrieves info about all backups existing on the XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $backups = Get-LXCABackups # show all the information about the request: # - Result value, # - Message if any, # - brief description of the backups if any. $backups # show detailed information about the existing backups. $backups.BackupInfos #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example exports a specific backup (using the -Uuid parameter) to the local system. # If the file with same name already exists, the old file is replaced. # The file name used for the exported file is the one that is returned by XClarity Administrator. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck #get info about the existing backups $backups = Get-LXCABackups #use the UUID of the first backup in the BackupInfos $file = Get-LXCABackups -Uuid $backups.BackupInfos[0].Uuid -Destination C:\LXCA\ -Overwrite # show all the information about the request: # - Result value, # - Message if any, # - The fully-qualified path of the downloaded file. $file #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCAChassis --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAChassis</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAChassis</command:noun> <dev:version /> </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. 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> <maml:name>Get-LXCAChassis</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAChassis</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis[]</maml:name> <maml:uri/> <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> <dev:code>$chassis = Get-LXCAChassis</dev:code> <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> <!-- Get-LXCAChassisInventory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAChassisInventory</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAChassisInventory</command:noun> <dev:version /> </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> <maml:name>Get-LXCAChassisInventory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAChassisInventory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ChassisInventory[]</maml:name> <maml:uri/> <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> <dev:code> $chassis = Get-LXCAChassis $chassisinventory = Get-LXCAChassisInventory -Chassis $chassis </dev:code> <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> <!-- Get-LXCAChassisMember --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAChassisMember</command:name> <maml:description> <maml:para>Gets the installed components (members) of one or more chassis.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAChassisMember</command:noun> <dev:version /> </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> <maml:name>Get-LXCAChassisMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAChassisMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAChassisMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemberUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MemberUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ChassisMember[]</maml:name> <maml:uri/> <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> <dev:code> $chassis = Get-LXCAChassis $chassmember = Get-LXCAChassisMember -Chassis $chassis[0] </dev:code> <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> <!-- Get-LXCAComputeNode --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAComputeNode</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAComputeNode</command:noun> <dev:version /> </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> <maml:name>Get-LXCAComputeNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAComputeNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAComputeNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>NodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ComputeNode[]</maml:name> <maml:uri/> <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> <dev:code> $nodes = Get-LXCAComputeNode </dev:code> <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> <!-- Get-LXCAConfigPattern --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAConfigPattern</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAConfigPattern</command:noun> <dev:version /> </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> <maml:name>Get-LXCAConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternID</maml:name> <maml:description> <maml:para>Specifies the pattern ID. If no PatternID is specified, all configuration patterns are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeSettings</maml:name> <maml:description> <maml:para>If specified, the cmdlets returns the detailed definition (settings) of the pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternID</maml:name> <maml:description> <maml:para>Specifies the pattern ID. If no PatternID is specified, all configuration patterns are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IncludeSettings</maml:name> <maml:description> <maml:para>If specified, the cmdlets returns the detailed definition (settings) of the pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigPattern[]</maml:name> <maml:uri/> <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> <dev:code>$patterns = Get-LXCAConfigPattern</dev:code> <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> <dev:code> $pattern = Get-LXCAConfigPattern -PatternId 33 -IncludeSettings $pattern.Settings </dev:code> <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> <!-- Get-LXCAConfigPatternDeployableServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAConfigPatternDeployableServer</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAConfigPatternDeployableServer</command:noun> <dev:version /> </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> <maml:name>Get-LXCAConfigPatternDeployableServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAConfigPatternDeployableServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>LXCAConfigPatternDeployableTarget</maml:name> <maml:uri/> <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> <dev:code> $patterns = Get-LXCAConfigPattern $chassis = Get-LXCAConfigPatternDeployableServer -PatternId $patterns[0].Id $chassis[0].Servers </dev:code> <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> <!-- Get-LXCAConfigProfile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAConfigProfile</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAConfigProfile</command:noun> <dev:version /> </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> <maml:name>Get-LXCAConfigProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileID</maml:name> <maml:description> <maml:para>Specifies the profile ID. If no profile ID is specified, all server profiles are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAConfigProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileID</maml:name> <maml:description> <maml:para>Specifies the profile ID. If no profile ID is specified, all server profiles are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigProfile[]</maml:name> <maml:uri/> <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> <dev:code>$profiles = Get-LXCAConfigProfile</dev:code> <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> <!-- Get-LXCAConnection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAConnection</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAConnection</command:noun> <dev:version /> </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> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection[]</maml:name> <maml:uri/> <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> <dev:code> $connections = Get-LXCAConnection foreach ($conn in $connections) { Disconnect-LXCA -Connection $conn } </dev:code> <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> <!-- Get-LXCADeployableServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCADeployableServer</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCADeployableServer</command:noun> <dev:version /> </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> <maml:name>Get-LXCADeployableServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCADeployableServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployableServer</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para> Get-LXCADeployableServer returns an array of Lenovo.SysMgmt.LXCA.Integration.Data.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> <dev:code> # # This command gets a list of all deployable servers. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred $servers = Get-LXCADeployableServer #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCADeployGlobalSetting --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCADeployGlobalSetting</command:name> <maml:description> <maml:para>Gets the global settings used for operating system deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCADeployGlobalSetting</command:noun> <dev:version /> </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> <maml:name>Get-LXCADeployGlobalSetting</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployGlobalSetting</maml:name> <maml:uri/> <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 Win2016R1Key Win2016R1; public class Win2012R1Key { public string StandardLicenseKey; public string DataCenterLicenseKey; } public class Win2012R2Key { public string StandardLicenseKey; public string DataCenterLicenseKey; } public class Win2016R1Key { 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> <dev:code> $setting = Get-LXCADeployGlobalSetting </dev:code> <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> <!-- Get-LXCADeviceMaintenance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCADeviceMaintenance</command:name> <maml:description> <maml:para> Retrieves maintenance status and schedules for a specific device. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCADeviceMaintenance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves maintenance status and schedules for a specific device. Schedules (start date and end date) returned for the device are translated to the TimeZone of the local machine. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCADeviceMaintenance</maml:name> <command:description> Gets the maintenance status of a specific device. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UUID</maml:name> <maml:description> <maml:para> Specifies the UUID of the device to check the maintenance status. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UUID</maml:name> <maml:description> <maml:para> Specifies the UUID of the device to check the maintenance status. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> Lenovo.SysMgmt.LXCA.Integration.Data.DeviceMaintenanceStatus </maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns Lenovo.SysMgmt.LXCA.Integration.Data.DeviceMaintenanceStatus object. If the device is not in maintenance mode, an exception with message "404 - Not Found" is thrown, and the DeviceMaintenanceStatus object has State property set to Unknown </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> <dev:code> # # The following example retieves maintenance status of a specific device. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $deviceUUID = "000123444" $(Get-LXCADeviceMaintenance -UUID $deviceUUID) Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCADevicesWarranty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCADevicesWarranty</command:name> <maml:description> <maml:para>This cmdlet retrieves or downloads information about warranties for managed devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCADevicesWarranty</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves or downloads information about warranties for managed devices. Note: You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCADevicesWarranty</maml:name> <command:description> Retrieve information about all warranties or all warranties in a specific state. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WarrantyStatusType</maml:name> <maml:description> <maml:para> Status of the warranties that you want to retrieve. This can be one of the following values. - All. (default) Returns information about all warranties. - ActiveOnly. Returns information about all active warranties. - ExpiredOnly. Returns information about all expired warranties. - NotAvailableOnly. Returns information about warranties for which the status is not available. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCADevicesWarranty</maml:name> <command:description> Download information about all warranties. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Directory and file name where the file is to be saved on the local system. - If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name (warrantyInfo-nn.csv) is used. - Otherwise, if the Destination string doesn't end with "\", the part that follows the last "\" in the Destination string is used as the name of the file. - If the directory does not exist, it is automatically created. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten and the "System.IO.IOException: The _full_csv_file_path_ file already exists" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>WarrantyStatusType</maml:name> <maml:description> <maml:para> Status of the warranties that you want to retrieve. This can be one of the following values. - All. (default) Returns information about all warranties. - ActiveOnly. Returns information about all active warranties. - ExpiredOnly. Returns information about all expired warranties. - NotAvailableOnly. Returns information about warranties for which the status is not available. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>String "All"</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>Destination</maml:name> <maml:description> <maml:para> Directory and file name where the file is to be saved on the local system. - If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name (warrantyInfo-nn.csv) is used. - Otherwise, if the Destination string doesn't end with "\", the part that follows the last "\" in the Destination string is used as the name of the file. - If the directory does not exist, it is automatically created. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten and the "System.IO.IOException: The _full_csv_file_path_ file already exists" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -Destination is specified, this cmdlet returns the System.String object, which contains the full path of the saved csv file, and downloads the file to the specified directory on the local system. . </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.WarrantyInfo[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -Destination is not specified, this cmdlet returns the Lenovo.SysMgmt.LXCA.Integration.Data.WarrantyInfo array that contains information for all warranties or for all warranties in a specific state. . </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> <dev:code> # # This example downloads all warranty information as a *csv file in the $PSScriptRoot\..\_lxca\warranties directory using the default file name. # If the file already exists, the file is overwritten. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Get-LXCADevicesWarranty -Destination "$PSScriptRoot\..\_csvTests\test2\" -Overwrite # $result contains the full path of the saved csv file. $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This example returns information about all expired warranties. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Get-LXCADevicesWarranty -WarrantyStatusType ExpiredOnly # $result contains an array of WarrantyInfo objects with expired Warranty Status. $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCAEncapsulation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAEncapsulation</command:name> <maml:description> <maml:para>Gets the global encapsulation setting on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAEncapsulation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCAEncapsulation cmdlet gets the global encapsulation setting on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAEncapsulation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Bool</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAEncapsulation returns the encapsulation setting (boolean 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> <dev:code>$ret = Get-LXCAEncapsulation</dev:code> <dev:remarks> <maml:para>This command returns the global encapsulation setting.</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> <!-- Get-LXCAEvent --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAEvent</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAEvent</command:noun> <dev:version /> </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> <maml:name>Get-LXCAEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventID</maml:name> <maml:description> <maml:para>Specifies the event ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PreviousHours</maml:name> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EndSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>All</maml:name> <maml:description> <maml:para>If specified, the cmdlets also returns the audit log entries.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventID</maml:name> <maml:description> <maml:para>Specifies the event ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PreviousHours</maml:name> <maml:description> <maml:para>Specifies how many hours prior to the current time should be used for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the start sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EndSequenceNumber</maml:name> <maml:description> <maml:para>Specifies the end sequence number for obtaining events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>All</maml:name> <maml:description> <maml:para>If specified, the cmdlets also returns the audit log entries.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Event[]</maml:name> <maml:uri/> <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> <dev:code> $events = Get-LXCAEvent -Severity Critical </dev:code> <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> <dev:code> $events = Get-LXCAEvent -Severity Major,Critical,Fatal -EventClass Blade -PreviousHours 12 </dev:code> <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> <dev:code> $events = Get-LXCAEvent -Severity Major,Critical,Fatal -StartSequenceNumber 100 -EndSequenceNumber 1000 </dev:code> <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> <!-- Get-LXCAEventExclusionFilter --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAEventExclusionFilter</command:name> <maml:description> <maml:para>Gets information about one or more event exclusion filters.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAEventExclusionFilter</command:noun> <dev:version /> </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> <maml:name>Get-LXCAEventExclusionFilter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FilterID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAEventExclusionFilter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FilterID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.EventExclusionFilter[]</maml:name> <maml:uri/> <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> <dev:code> Get-LXCAEventExclusionFilter -SourceID AAAAAAAAAAAA </dev:code> <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> <!-- Get-LXCAFFDCFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAFFDCFile</command:name> <maml:description> <maml:para> Gets the FFDC file from the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAFFDCFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet downloads the First Failure Data Capture (FFDC) file to the local system. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAFFDCFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Directory and file name where the file is to be saved on the local system. - If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name (LXCA_app-uuid_time_date.tar.gz) is used. - Otherwise, if the Destination string doesn't end with "\", the part that follows the last "\" in the Destination string is used as the name of the file. - If the directory does not exist, it is automatically created. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten and the "System.IO.IOException: The _full_file_path_ file already exists" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Directory and file name where the file is to be saved on the local system. - If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name (LXCA_app-uuid_time_date.tar.gz) is used. - Otherwise, if the Destination string doesn't end with "\", the part that follows the last "\" in the Destination string is used as the name of the file. - If the directory does not exist, it is automatically created. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">system.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten and the "System.IO.IOException: The _full_file_path_ file already exists" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a System.String object, which contains the full path of the saved FFDC file on the local system. . </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - The returned FFDC file is a tar.gz archive. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This example downloads the FFDC file, saves it on the local system and prints in PS console the file's fully qualified path. # If the file with same name already exists, the old one will be replaced. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Get-LXCAFFDCFile -Destination C:\LXCA\ffdc.tar.gz -Overwrite) #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This example downloads the FFDC file, saves it on the local system and prints in PS console the file's fully qualified path. # The file name used is the one that is returned by LXCA. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Get-LXCAFFDCFile -Destination C:\LXCA\) #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCAInformation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAInformation</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAInformation</command:noun> <dev:version /> </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> <maml:name>Get-LXCAInformation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>LXCAInformation</maml:name> <maml:uri/> <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> <dev:code> $info = Get-LXCAInformation </dev:code> <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> <!-- Get-LXCAIOModule --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAIOModule</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAIOModule</command:noun> <dev:version /> </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> <maml:name>Get-LXCAIOModule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAIOModule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAIOModule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IOModuleUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>IOModuleUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.IOModule[]</maml:name> <maml:uri/> <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> <dev:code>$iomodules = Get-LXCAIOModule -ChassisUuid 1B33D6CE9FFD410158210817F476E900</dev:code> <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> <!-- Get-LXCAJobNotes --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAJobNotes</command:name> <maml:description> <maml:para> Retrieves the notes history for a specific job (task). </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAJobNotes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves the notes history for a specific job (task). Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAJobNotes</maml:name> <command:description> Retrieves the notes history for a specific job (task). </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>JobUID</maml:name> <maml:description> <maml:para> Specifies the UID of the job. If the job does not exist, "404 - Not Found" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>JobUID</maml:name> <maml:description> <maml:para> Specifies the UID of the job. If specified job does not exist, "404 - Not Found" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> Lenovo.SysMgmt.LXCA.Integration.Data.JobNotes[] </maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.JobNotes array that contains information about all the notes for a specific job. </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> <dev:code> # # The following example retrieves all notes from a specific job. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $jobUID = 123444 $(Get-LXCAJobNotes -JobUID $jobUID) Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCALicenseCompliance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCALicenseCompliance</command:name> <maml:description> <maml:para> Retrieves information about whether Lenovo XClarity Administrator is license compliant. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCALicenseCompliance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves information about whether Lenovo XClarity Administrator is license compliant. This cmdlet retrieves information about whether Lenovo XClarity Administrator is license compliant. License compliance is determined based on the number of managed devices that support the advanced functions. The number of managed devices must not exceed the total number of licenses in all active license keys. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCALicenseCompliance</maml:name> <command:description> Retrieves information about whether Lenovo XClarity Administrator is license compliant. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LicenseComplianceData</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.LicenseComplianceData object, that contains information about the license compliance status. Note: - For XClarity Administrator version 2.7.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - This cmdlet requires XClarity Administrator v2.8.0 or later. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This example retrieves the license compliance status of the Lenovo XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $compliance = Get-LXCALicenseCompliance # show all information about the request: $compliance # show compliance status. $compliance.Status #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCALicensableDeviceCount --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCALicensableDeviceCount</command:name> <maml:description> <maml:para> Retrieves the number of managed devices that require licenses for advanced functions. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCALicensableDeviceCount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves the number of managed devices that require licenses for advanced functions. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCALicensableDeviceCount</maml:name> <command:description> Retrieves the number of devices that are currently managed by Lenovo XClarity Administrator and are subject to licenses. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdelt returns the number of the managed devices that are subject to licensing. Note: - For XClarity Administrator version 2.7.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - This cmdlet requires XClarity Administrator v2.8.0 or later. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This example retrieves the number of managed devices that are subject to licensing. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $deviceCount = Get-LXCALicensableDeviceCount $deviceCount #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCALicenseWarningPeriod --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCALicenseWarningPeriod</command:name> <maml:description> <maml:para> Retrieves information about the license warning period on the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCALicenseWarningPeriod</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves the license warning period, which determines the number of days before a license expires when Lenovo XClarity Administrator triggers a warning. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCALicenseWarningPeriod</maml:name> <command:description> Retrieves information about the license warning period on the Lenovo XClarity Administrator server. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LicenseWarningPeriod</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.LicenseWarningPeriod object, that contains information about the license warning period on the XClarity Administrator server. Note: - For XClarity Administrator version 2.8.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - This cmdlet requires XClarity Administrator v3.0.0 or later. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This example retrieves the license warning period on the Lenovo XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $warning = Get-LXCALicenseWarningPeriod # show all information about the request: $warning # show warning period value. $warning.WarningPeriod #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCAManagementServerPackage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAManagementServerPackage</command:name> <maml:description> <maml:para>Returns management server update packages info from the Lenovo XClarity Administrator server update repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAManagementServerPackage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCAManagementServerPackage cmdlet returns management server update packages info from the Lenovo XClarity Administrator server update repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAManagementServerPackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAManagementServerPackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <maml:description> <maml:para>Specifies one fixId. If no fixId is specified, update packages for all infomation will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <maml:description> <maml:para>Specifies one fixId. If no fixId is specified, update packages for all infomation will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ManagementServerUpdateShowDTO</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAManagementServerPackage returns 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> <dev:code> $packages = Get-LXCAManagementServerPackage </dev:code> <dev:remarks> <maml:para>This command returns a update packages info from the Lenovo XClarity Administrator server update 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> <dev:code> $packages = Get-LXCAManagementServerPackage -FixId $fixId </dev:code> <dev:remarks> <maml:para>This command returns update packages for fixId($fixId) from the Lenovo XClarity Administrator server update 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> <!-- Get-LXCAOSImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAOSImage</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> </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> <maml:name>Get-LXCAOSImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.OSImage[]</maml:name> <maml:uri/> <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> <dev:code> $images = Get-LXCAOSImage </dev:code> <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> <!-- Get-LXCAQuantityLicense --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAQuantityLicense</command:name> <maml:description> <maml:para> Retrieve information about installed licenses on the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAQuantityLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves all installed licenses or export a specified list of the installed licenses to the local system. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAQuantityLicense</maml:name> <command:description> Retrieve information about all the installed licenses on the Lenovo XClarity Administrator server </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAQuantityLicense</maml:name> <command:description> Export a specified list of the installed licenses to the local system. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseIds</maml:name> <maml:description> <maml:para> Specifies a list of IDs of licenses to be exported, separated by a comma. Note: - The list is filtered to match the IDs of the installed licenses. Therefore: * Only founded licenses are exported. * If no license is found, the ERROR: Licenses with IDs 'licenses_ids' are not installed on LXCA message is displayed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the directory and file name where the file is to be saved on the local system. - If you specify a directory but not a file name (in other words, if the string ends with a back slash "\"), the file name that is returned by the XClarity Administrator is used. - If the directory does not exist, it is automatically created. - If you specify a string that does not end with a backslash "\", the name after the last backslash "\" is used as the file name. Note: The cmdlet might modify the file extension to reflect the actual file type. The type depends on how many installed licenses can be exported. * If only one license can be exported, the exported file is the license key, and the file extension is "key". * If multiple licenses can be exported, the exported file is an archive license keys, and the file extension is "zip". </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The _full_file_path_ file already exists exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the directory and file name where the file is to be saved on the local system. - If you specify a directory but not a file name (in other words, if the string ends with a back slash "\"), the file name that is returned by the XClarity Administrator is used. - If the directory does not exist, it is automatically created. - If you specify a string that does not end with a backslash "\", the name after the last backslash "\" is used as the file name. Note: The cmdlet might modify the file extension to reflect the actual file type. The type depends on how many installed licenses can be exported. * If only one license can be exported, the exported file is the license key, and the file extension is "key". * If multiple licenses can be exported, the exported file is an archive license keys, and the file extension is "zip". </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">system.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> When specified, if the file already exists in the specified directory, the file is overwritten. The default value for Overwrite is false. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The _full_file_path_ file already exists exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseIds</maml:name> <maml:description> <maml:para> Specifies a list of IDs of licenses to be exported, separated by a comma. Note: - The list is filtered to match the IDs of the installed licenses. Therefore: * Only founded licenses are exported. * If no license is found, the ERROR: Licenses with IDs 'licenses_ids' are not installed on LXCA message is displayed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.QuantityLicense</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.QuantityLicense object that contains information about all the installed licenses on the Lenovo XClarity Administrator server. Note: - For XClarity Administrator version 2.7.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> When –LicensesIds parameter is specified, this cmdlet returns a System.String object, which contains the full path of the exported licenses file on the local system. Note: - For XClarity Administrator version 2.7.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - This cmdlet requires XClarity Administrator v2.8.0 or later. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # The following example retrieves all licenses that are installed on the XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $license = Get-LXCAQuantityLicense # show all the information about the request: # - Result value, # - Message if any, # - brief description of the licenses data if any. $license # show detailed information about the installed licenses. $license.Licenses #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example exports specific licenses (using the -LicensesIds parameter) to the local system and returns the fully-qualified path of the file. # If the file with same name already exists, the old file is replaced. # The file name used for the exported file is the one that is returned by XClarity Administrator. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $file = Get-LXCAQuantityLicense -LicenseIds 1,3,5 -Destination C:\LXCA\ -Overwrite $file #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCARack --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCARack</command:name> <maml:description> <maml:para>This cmdlet retrieves information about one or more racks.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCARack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves information about one or more racks. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCARack</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the rack. If no UUID is specified, this cmdlet will return all existing rack instances.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of rack. If no UUID specified, this cmdlet will return all existing rack instances.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Rack[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns one or more Rack 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> <dev:code> # # The following example retrieves information about the rack with UUID AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $racks = Get-LXCARack -RackUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA # show racks data. $racks #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCARackServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCARackServer</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCARackServer</command:noun> <dev:version /> </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> <maml:name>Get-LXCARackServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCARackServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Uuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackServer[]</maml:name> <maml:uri/> <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> <dev:code>$rackservers = Get-LXCARackServer</dev:code> <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> <!-- Get-LXCARackSwitch --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCARackSwitch</command:name> <maml:description> <maml:para>Gets inventory data about one or more RackSwitch switches from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCARackSwitch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCARackSwitch cmdlet gets inventory data about one or more RackSwitch switches from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCARackSwitch</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns all RackSwitch switches that are not currently managed. If not specified, this cmdlet returns all managed RackSwitch switches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCARackSwitch</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of RackSwitch switches. If no UUID is specified, the cmdlet returns all managed RackSwitch switches unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns all RackSwitch switches that are not currently managed. If not specified, this cmdlet returns all managed RackSwitch switches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of RackSwitch switches. If no UUID is specified, the cmdlet returns all managed RackSwitch switches unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns all RackSwitch switches that are not currently managed. If not specified, this cmdlet returns all managed RackSwitch switches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RackSwitch[]</maml:name> <maml:uri/> <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> <dev:code>$rackswitches = Get-LXCARackSwitch</dev:code> <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> <!-- Get-LXCAResourceGroups --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAResourceGroups</command:name> <maml:description> <maml:para> This cmdlet retrieves information about a specific resource group or all resource groups. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAResourceGroups</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves information about the Resource Groups or a specific resource group. Note: You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAResourceGroups</maml:name> <command:description> This cmdlet retrieves information about all static resource groups existing in LXCA or about a specific static resource group specified by group UUID. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para> Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para> Specifies the Resource Groups type. This can be the following value: - Static </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupUuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the resource group to be retrieved. If not specified, information about all static resource groups are returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para> Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para> Specifies the Resource Groups type. This can be the following value: - Static </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupUuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the resource group to be retrieved. If not specified, information about all static resource groups are returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ResourceGroup[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -GroupUuid is not specified, this cmdlet returns an array of Lenovo.SysMgmt.LXCA.Integration.Data.ResourceGroup objects. . </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ResourceGroup</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -GroupUuid is specified, this cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.ResourceGroup object for the group with specified UUID. . </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> <dev:code> # # The following example returns the information about a specific resource group. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $uuid = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" $result = Get-LXCAResourceGroups -Type Static -GroupUuid $uids $result # Group members can be founded in: $result.Members #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example returns the information about all static resource groups. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Get-LXCAResourceGroups -Type Static $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCARole --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCARole</command:name> <maml:description> <maml:para>Use the this cmdlet to retrieve information about all roles name.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCARole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCARole cmdlet to retrieve information about all roles name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCARole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCARole returns role name info.</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> <dev:code> $role = Get-LXCARole </dev:code> <dev:remarks> <maml:para>This command returns all roles name.</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> <!-- Get-LXCARoleGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCARoleGroup</command:name> <maml:description> <maml:para>Use the this cmdlet to retrieve information about one or more role groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCARoleGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCAManagementServerPackage cmdlet retrieves information about one or more role groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCARoleGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCARoleGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies one role group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies one group name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RoleGroup</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCARoleGroup returns groups 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> <dev:code> $roleGroup = Get-LXCARoleGroup </dev:code> <dev:remarks> <maml:para>This command returns all role groups.</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> <dev:code> $roleGroup = Get-LXCARoleGroup -GroupName $name </dev:code> <dev:remarks> <maml:para>Filter information according to group name.</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> <!-- Get-LXCAScalableComplexSystem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAScalableComplexSystem</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAScalableComplexSystem</command:noun> <dev:version /> </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> <maml:name>Get-LXCAScalableComplexSystem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of one or more scalable complex systems.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServer</maml:name> <maml:description> <maml:para>Specifies that the scalable complex system is created from System x servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAScalableComplexSystem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of one or more scalable complex systems.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies that the scalable complex system is created from Flex System compute nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of one or more scalable complex systems.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServer</maml:name> <maml:description> <maml:para>Specifies that the scalable complex system is created from System x servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies that the scalable complex system is created from Flex System compute nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ComplexForComputeNode or Lenovo.SysMgmt.LXCA.Integration.Data.ComplexForRackServer</maml:name> <maml:uri/> <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> <dev:code> Get-LXCAScalableComplexSystem -RackServer </dev:code> <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> <!-- Get-LXCASchedule --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCASchedule</command:name> <maml:description> <maml:para>Gets one or more schedule info from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCASchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCASchedule cmdlet will be retrieve one or more schedule info from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCASchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCASchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies one of schedule name[Fuzzy matching]. If no schedule name is specified, the cmdlet returns all schedule info.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCASchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ScheduleType</maml:name> <maml:description> <maml:para>Specifies one of schedule type. If no schedule type is specified, the cmdlet returns all schedule info.</maml:para> <maml:para>One Time:Returns the schedule information of the 'One Time'. </maml:para> <maml:para>Recurring:Returns the schedule information of the 'Recurring'. </maml:para> <maml:para>Triggered:Returns the schedule information of the 'Triggered'. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies one of schedule name[Fuzzy matching]. If no schedule name is specified, the cmdlet returns all schedule info.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ScheduleType</maml:name> <maml:description> <maml:para>Specifies one of schedule type. If no schedule type is specified, the cmdlet returns all schedule info.</maml:para> <maml:para>One Time:Returns the schedule information of the 'One Time'. </maml:para> <maml:para>Recurring:Returns the schedule information of the 'Recurring'. </maml:para> <maml:para>Triggered:Returns the schedule information of the 'Triggered'. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Data.ScheduleShowDTO[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Data.ScheduleShowDTO[]</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> <dev:code> Get-LXCASchedule </dev:code> <dev:remarks> <maml:para>This command will be return all schedule infomation.</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> <dev:code> Get-LXCASchedule -ScheduleName $name </dev:code> <dev:remarks> <maml:para></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> <dev:code> Get-LXCASchedule -ScheduleType 'One Time' </dev:code> <dev:remarks> <maml:para>Returns the schedule information of the 'One Time'.</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> <!-- Get-LXCAServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAServer</command:name> <maml:description> <maml:para>Gets information about one or more servers from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCAServer cmdlet gets information about all severs (including rack serves and compute nodes) from Lenovo XClarity Administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns all servers that are not currently managed. If not specified, this cmdlet returns managed all servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the UUIDs of one or more servers for which information is to be returned. If no UUID is specified, the cmdlet returns information for all servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns servers that are not currently managed. If not specified, this cmdlet returns managed servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the UUIDs of one or more servers for which information is to be returned. If no UUID is specified, the cmdlet returns information for all servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns servers that are not currently managed. If not specified, this cmdlet returns managed servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>System.Object</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAServer returns inventory data for one or more servers (including rack servers and compute nodes).</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> <dev:code>Get-LXCAServer</dev:code> <dev:code>Get-LXCAServer -Unmanaged</dev:code> <dev:remarks> <maml:para>This command returns a list of all managed servers or unmanaged servers .</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> <dev:code>Get-LXCAServer -Uuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB</dev:code> <dev:code>Get-LXCAServer -Uuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA,BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB -Unmanaged</dev:code> <dev:remarks> <maml:para>This command returns inforamtion about specific managed or unmanaged 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> <!-- Get-LXCAServiceFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAServiceFile</command:name> <maml:description> <maml:para>Gets the service First Failure Data Capture (service) file for a specified device (such as a chassis, a rack server, a rack switch or a storage) to the local system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAServiceFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet downloads the service First Failure Data Capture (service) file for a specified device (such as a chassis, a rack server, a rack switch or a storage) to the local system. Note: - This cmdlet downloads a service that was collected previously. This cmdlet does not collect service data for the device. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAServiceFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the local path where the file is to be saved. The file is downloaded as 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 exist. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If specified, the cmdlet overwrites the local file when a file with that same name exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAServiceFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>All</maml:name> <maml:description> <maml:para>If specified, the cmdlet downloads FFDC data for all managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the local path where the file is to be saved. The file is downloaded as 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 exist. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If specified, the cmdlet overwrites the local file when a file with that same name exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>All</maml:name> <maml:description> <maml:para>If specified, the cmdlet downloads FFDC data for all managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the local path where the file is to be saved. The file is downloaded as 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 exist. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If specified, the cmdlet overwrites the local file when a file with that same name exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns the path to the FFDC file 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> <dev:code> # # 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. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred Get-LXCAFServiceFile -Uuid AAAAAAAAAAAAAAAA -Destination C:\LXCA\ -Overwrite #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This command downloads the service FFDC file of all endpoints and saves it to C:\LXCA\myFFDC.tar.gz $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred Get-LXCAServiceFile -All -Destination C:\LXCA\myFFDC.tar.gz #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCAServiceTickets --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAServiceTickets</command:name> <maml:description> <maml:para>This cmdlet retrieves information about Service Tickets.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAServiceTickets</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves information about Service Tickets. Note: You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAServiceTickets</maml:name> <command:description> Retrieve information about all Service Tickets or all Service Tickets in a specific state. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuids</maml:name> <maml:description> <maml:para> Returns information about service tickets that are associated with one or more specific groups and devices, specified by UUID. If not specified, information about all service tickets for all groups and devices are returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TicketState</maml:name> <maml:description> <maml:para> Returns information about service tickets that are in a specific state. You can specify one of the following values: - Created; - Submitted; - Answered; - Closed; - Cancelled; - Error; - Rejected; - Processing; - Initialized; - Waiting; - Unknown; - Active; - Resolved; - Canceled; - NewState; - InProgress; - OnHold; - WaitingForDetails; - Researching; - DeniedParty; - ProblemInitiation; - WaitingForLenovoInternalSupport; - WaitingForExternalSupportParty; - WaitingForCustomerFeedbackForSolution; - WaitingForSolutionDeployment; - ProblemSolved; - MonitoringSolutionDeployment; - SolutionProvided; - TransferredToManagedServices; - CustomerCanceled; - Merged; - WarmTransfer; - Duplicate; - WorkInProgress; - Pending; If not specified, information about all service tickets for all groups and devices are returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuids</maml:name> <maml:description> <maml:para> Returns information about service tickets that are associated with one or more specific groups and devices, specified by UUID. If not specified, information about all service tickets for all groups and devices are returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TicketState</maml:name> <maml:description> <maml:para> Returns information about service tickets that are in a specific state. You can specify one of the following values: - Created; - Submitted; - Answered; - Closed; - Cancelled; - Error; - Rejected; - Processing; - Initialized; - Waiting; - Unknown; - Active; - Resolved; - Canceled; - NewState; - InProgress; - OnHold; - WaitingForDetails; - Researching; - DeniedParty; - ProblemInitiation; - WaitingForLenovoInternalSupport; - WaitingForExternalSupportParty; - WaitingForCustomerFeedbackForSolution; - WaitingForSolutionDeployment; - ProblemSolved; - MonitoringSolutionDeployment; - SolutionProvided; - TransferredToManagedServices; - CustomerCanceled; - Merged; - WarmTransfer; - Duplicate; - WorkInProgress; - Pending; If not specified, information about all service tickets for all groups and devices are returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ServiceTicket[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <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> <dev:code> # # The following example returns all service tickets that are associated with two specific devices. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $uids = @("AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB") $result = Get-LXCAServiceTickets -Uuids $uids $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example retrieves returns service tickets that are in the "Processing" state for all devices in a specific group. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $groupUids = @("AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA") $result = Get-LXCAServiceTickets -Uuids $groupUids -TicketState Processing $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCAStorage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAStorage</command:name> <maml:description> <maml:para>Gets inventory data about one or more Lenovo Storage systems from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAStorage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-LXCAStorage cmdlet gets inventory data about one or more Lenovo Storage systems from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAStorage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns all Lenovo Storage systems that are not currently managed. If not specified, this cmdlet returns all managed Lenovo Storage systems.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAStorage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of Lenovo Storage systems. If no UUID is specified, the cmdlet returns all managed Lenovo Storage systems unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns all Lenovo Storage systems that are not currently managed. If not specified, this cmdlet returns all managed Lenovo Storage systems.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies one or more UUIDs of Lenovo Storage systems. If no UUID is specified, the cmdlet returns all managed Lenovo Storage systems unless you also specify the -Unmanage parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns all Lenovo Storage systems that are not currently managed. If not specified, this cmdlet returns all managed Lenovo Storage systems.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Storage[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Get-LXCAStorage returns a list of Lenovo Storage systems.</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> <dev:code>$storages = Get-LXCAStorage</dev:code> <dev:remarks> <maml:para>This command returns a list of all managed Lenovo Storage systems.</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> <!-- Get-LXCAStorageNode --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAStorageNode</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAStorageNode</command:noun> <dev:version /> </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> <maml:name>Get-LXCAStorageNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAStorageNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAStorageNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Chassis</maml:name> <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> <command:parameterValue required="true" variableLength="false">Chassis[]</command:parameterValue> <dev:type> <maml:name>Chassis[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="fasle" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Chassis</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.StorageNode</maml:name> <maml:uri/> <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> <dev:code> $nodes = Get-LXCAStorageNode </dev:code> <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> <!-- Get-LXCAStoredCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAStoredCredential</command:name> <maml:description> <maml:para> Retrieves information for stored credentials from the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCAStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves information for stored credentials from the Lenovo XClarity Administrator server. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCAStoredCredential</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para> Specifies the ID of the stored credential. If not specified, information about all stored credentials is returned </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para> Specifies the ID of the stored credential. If not specified, information about all stored credentials is returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>- Lenovo.SysMgmt.LXCA.Integration.Data.StoredCredentialData</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -Id is specified, this cmdlet returns a single StoredCredentialData object, for the stored credential with specified Id. </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>- Lenovo.SysMgmt.LXCA.Integration.Data.StoredCredentialData[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -Id is not specified, this cmdlet returns an array of StoredCredentialData objects, for all stored credentials existing in XClarity Administrator. </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> <dev:code> # # The following example retrieves information for all stored credential. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $account = Get-LXCAStoredCredential Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCASwitchConfigData --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCASwitchConfigData</command:name> <maml:description> <maml:para> This cmdlet retrieves information about configuration-data files for RackSwtich and Flex System switches. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCASwitchConfigData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Get-LXCASwitchConfigData cmdlet retrieves information about configuration-data files for RackSwtich and Flex System switches. Note: You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCASwitchConfigData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para> Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch for which information is to be retrieved. If not specified, this cmdlet retrieves information about configuration-data files for all managed RackSwtich and Flex System switches. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConfigData</maml:name> <maml:description> <maml:para>If specified, detailed information about the configuration-data files are displayed: comment, date, file ID, file name, size, and switch UUID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch for which information is to be retrieved. If not specified, this cmdlet retrieves information about configuration-data files for all managed RackSwtich and Flex System switches. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConfigData</maml:name> <maml:description> <maml:para>If specified, detailed information about the configuration-data files are displayed: comment, date, file ID, file name, size, and switch UUID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.SwitchConfigData[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -Uuid and -ConfigData are not specified, the cmdlet returns an array of Lenovo.SysMgmt.LXCA.Integration.Data.SwitchConfigData objects, for all managed switches. - </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.SwitchConfigData</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -Uuid is specified and -ConfigData is not specified, the cmdlet returns a single Lenovo.SysMgmt.LXCA.Integration.Data.SwitchConfigData object, for the switch with the given UUID. - </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigData[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If -ConfigData is specified, the cmdlet returns an array of Lenovo.SysMgmt.LXCA.Integration.Data.ConfigData objects. In this case, if -Uuid is specified, the array contains data for the switch with the given UUID; otherwise, the array contains data for all managed 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> <dev:code> # # This example retrieves information about configuration-data files for all managed switches, and then displays the detailed information. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck # following two blocks are equivalent in generated output. # Block 1 $switchesConfig = Get-LXCASwitchConfigData # $switchesConfig is an array of Lenovo.SysMgmt.LXCA.Integration.Data.SwitchConfigData objects. $switchesConfig.ConfigDatas # Block 2 Get-LXCASwitchConfigData -ConfigData #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This example retrieves information about configuration-data files for the switch with the specified UUID, and then displays the detailed information. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $switchUuid = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" # following two blocks are equivalent in generated output. # Block 1 $switchConfig = Get-LXCASwitchConfigData -Uuid $switchUuid # $switchConfig is asingle Lenovo.SysMgmt.LXCA.Integration.Data.SwitchConfigData object. $switchConfig.ConfigDatas # Block 2 Get-LXCASwitchConfigData -Uuid $switchUuid -ConfigData #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCASwitchConfigFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCASwitchConfigFile</command:name> <maml:description> <maml:para> This cmdlet downloads (exports) one or more switch configuration-data files to the local system. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCASwitchConfigFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet downloads (exports) one or more switch configuration-data files to the local system. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCASwitchConfigFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data files. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the local directory where the file is to be saved. If not specified, this cmdlet downloads a file named LXCAConfig_files.zip to the current PowerShell working directory. Note: - The full specified path must exist. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> If specified, the cmdlet overwrites the local file when a file with that same name exists already. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data file stored on the XClarity Administrator. You can retieve file names using Get-LXCASwitchConfigData cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Destination</maml:name> <maml:description> <maml:para> Specifies the local directory where the file is to be saved. If not specified, this cmdlet downloads a file named LXCAConfig_files.zip to the current PowerShell working directory. Note: - The full specified path must exist. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Overwrite</maml:name> <maml:description> <maml:para> If specified, the cmdlet overwrites the local file when a file with that same name exists already. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns full mane of the retrieved file. </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> <dev:code> # # The following example downloads a single configuration-data file to the # C:\LXCA directory on the local system, and overwrites the file if it already exists. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $configFilesArchive = Get-LXCASwitchConfigFile -FileName $filename -Destination C:\LXCA\ -Overwrite $configFilesArchive Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example downloads all configuration-data files to the # current PowerShell working directory on the local system. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $configData = Get-LXCASwitchConfigData -ConfigData $files = @() foreach ($config in $configData) { $files += $config.FileName } $configFilesArchive = Get-LXCASwitchConfigFile -FileName $files $configFilesArchive Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCASystemCompliance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCASystemCompliance</command:name> <maml:description> <maml:para>Gets system compliance information from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCASystemCompliance</command:noun> <dev:version /> </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, System x servers, RackSwitch switch or Lenovo storage, to which a compliance policy has been assigned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCASystemCompliance</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemUuid</maml:name> <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, System x server, RackSwitch switch or Lenovo storage. If you specify a chassis, information for endpoints installed in the chassis are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - Chassis. The specified device is a chassis. The compliance information for the CMM, Flex switch, and Flex System computes nodes installed in the chassis will be returned. - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCASystemCompliance</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuids</maml:name> <maml:description> <maml:para> Specifies the UUIDs of the target systems. - The target systems can be CMMs, Flex switches, Flex System compute nodes, System x servers, RackSwitch switches or Lenovo storages. - If you request compliances for a list of chassises, the command is dropped: a null object is retuned. </maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. - If you request compliances for a list of chassises, the command is dropped: a null object is retuned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuids</maml:name> <maml:description> <maml:para> Specifies the UUIDs of the target systems: - The target systems can be CMMs, Flex switches, Flex System compute nodes, System x servers, RackSwitch switches or Lenovo storages. - If requested compliances are for a list of chassises, the command is dropped: a null object is retuned. </maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - Chassis. The specified device is a chassis. The compliance information for the CMM, Flex switch, and Flex System computes nodes installed in the chassis will be returned. - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <dev:type> <maml:name>SystemType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.SystemCompliance[]</maml:name> <maml:uri/> <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 - Syngle UUID ------------------ </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> $compliance = Get-LXCASystemCompliance -SystemUuid 2B885CEB5B6711E1A12B5CF3FC11314A -SystemType Chassis </dev:code> <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:example> <maml:title> ------------------ EXAMPLE 2 - Multiple UUIDs ----------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> $requiredUuis = "2B885CEB5B6711E1A12B5CF3FC11314A", "3C995CEB5B6711E1A12B5CF3FC11314A" $compliance = Get-LXCASystemCompliance -Uuids $requiredUuis -SystemType ComputeNode </dev:code> <dev:remarks> <maml:para>This command gets the system compliance information for two ComputeNode.</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> <!-- Get-LXCATask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCATask</command:name> <maml:description> <maml:para>Gets one or more tasks (jobs) from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCATask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet retrieves information about one or more tasks (jobs) from the Lenovo XClarity Administrator server. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCATask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskId"> <maml:name>LegacyMode</maml:name> <maml:description> <maml:para> This parameter is deprecated and will be removed at a future date. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCATask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskId"> <maml:name>TaskUIDs</maml:name> <maml:description> <maml:para> Specifies one or more task IDs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -JobID -TaskId -TaskUID </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskId"> <maml:name>LegacyMode</maml:name> <maml:description> <maml:para> This parameter is deprecated and will be removed at a future date. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCATask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="UUid"> <maml:name>TargetUUIDs</maml:name> <maml:description> <maml:para> Specifies one or more UUIDs of the components to which the task belongs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -TargetUUID -Uuid </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Category</maml:name> <maml:description> <maml:para> Specifies the categories to which the task belongs. You can specify one or more of the following values, separated by a comma. - Backup - Configuration - Custom - Firmware - Health - Inventory - Management - OsDeployment - OsDriverUpdates - OsImport - OsProfileExport - Power - RemoteAccess - SelfMaintenance - Service - SwitchConfiguration - SystemId - Unknown </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para> Specifies the current states of the task. You can specify one or more of the following values, separated by a comma. - Aborted - Blocked - Cancelled - CancelledWithError - CancelledWithWarning - Cancelling - Complete - CompleteWithError - CompleteWithWarning - Expired - Initializing - Interrupted - InterruptedWithError - InterruptedWithWarning - Investigating - Pending - Resolved - Running - RunningWithError - RunningWithWarning - Skipped - Stopped - StoppedWithError - StoppedWithWarning - Uploading - Validating - Waiting - Unknown </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LegacyMode</maml:name> <maml:description> <maml:para> This parameter is deprecated and will be removed at a future date. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskID"> <maml:name>TaskUIDs</maml:name> <maml:description> <maml:para> Specifies one or more task IDs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -JobID -TaskId -TaskUID </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="UUid"> <maml:name>TargetUUIDs</maml:name> <maml:description> <maml:para> Specifies one or more UUIDs of the components to which the task belongs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -TargetUUID -Uuid </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Category</maml:name> <maml:description> <maml:para> Specifies the categories to which the task belongs. You can specify one or more of the following values, separated by a comma. - Backup - Configuration - Custom - Firmware - Health - Inventory - Management - OsDeployment - OsDriverUpdates - OsImport - OsProfileExport - Power - RemoteAccess - SelfMaintenance - Service - SwitchConfiguration - SystemId - Unknown </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Sysytem.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para> Specifies the current states of the task. You can specify one or more of the following values, separated by a comma. - Aborted - Blocked - Cancelled - CancelledWithError - CancelledWithWarning - Cancelling - Complete - CompleteWithError - CompleteWithWarning - Expired - Initializing - Interrupted - InterruptedWithError - InterruptedWithWarning - Investigating - Pending - Resolved - Running - RunningWithError - RunningWithWarning - Skipped - Stopped - StoppedWithError - StoppedWithWarning - Uploading - Validating - Waiting - Unknown </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LegacyMode</maml:name> <maml:description> <maml:para> This parameter is deprecated and will be removed at a future date. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> - Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[] </maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob array that contains information about all the jobs in XClarity Administrator, all jobs with specified UIDs, or jobs that are filtered by target UUID, state and category. </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> <dev:code> # # This command gets all the jobs from the Lenovo XClarity Administrator server that are currently running. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $jobs = Get-LXCATask -State Running,RunningWithError,RunningWithWarning Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Get-LXCAThinkServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAThinkServer</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAThinkServer</command:noun> <dev:version /> </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> <maml:name>Get-LXCAThinkServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAThinkServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Uuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Unmanaged</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ThinkServer[]</maml:name> <maml:uri/> <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> <dev:code>$thinkservers = Get-LXCAThinkServer</dev:code> <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> <!-- Get-LXCAUpdateCompliancePolicy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAUpdateCompliancePolicy</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAUpdateCompliancePolicy</command:noun> <dev:version /> </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> <maml:name>Get-LXCAUpdateCompliancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCAUpdateCompliancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <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> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>SystemType</maml:name> <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> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <dev:type> <maml:name>SystemType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.CompliancePolicy[]</maml:name> <maml:uri/> <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> <dev:code>$policy = Get-LXCAUpdateCompliancePolicy</dev:code> <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> <dev:code>$policy = Get-LXCAUpdateCompliancePolicy -SystemUuid 2B885CEB5B6711E1A12B5CF3FC11314A -SystemType ComputeNode</dev:code> <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> <!-- Get-LXCAUpdatePackage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAUpdatePackage</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAUpdatePackage</command:noun> <dev:version /> </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> <maml:name>Get-LXCAUpdatePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MachineType</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MachineType</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UpdatePackage[]</maml:name> <maml:uri/> <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> <dev:code> $packages = Get-LXCAUpdatePackage </dev:code> <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> <dev:code> $packages = Get-LXCAUpdatePackage -MachineType 7893,8724 </dev:code> <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> <!-- Get-LXCAUserAccount --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LXCAUserAccount</command:name> <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> <command:verb>Get</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> </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> <maml:name>Get-LXCAUserAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <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> <dev:code> $accounts = Get-LXCAUserAccount </dev:code> <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> <!-- Import-LXCAConfigPattern --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-LXCAConfigPattern</command:name> <maml:description> <maml:para>Imports a configuration pattern to the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>LXCAConfigPattern</command:noun> <dev:version /> </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> <maml:name>Import-LXCAConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Settings</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Settings</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>String</maml:name> <maml:uri/> <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> <dev:code> $settings = Get-Content -Path "c:\pattern_setting.txt" Import-LXCAConfigPattern -Setting $settings </dev:code> <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> <!-- Import-LXCAOSImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-LXCAOSImage</command:name> <maml:description> <maml:para> This cmdlet imports a local OS image or device driver into the OS-images repository. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet imports a local OS image or device driver into the OS-images repository. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-LXCAOSImage</maml:name> <command:description> Imports a local OS image into the OS-images repository. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImagePath</maml:name> <maml:description> <maml:para> Specifies the file path and file name to be imported. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChecksumType</maml:name> <maml:description> <maml:para> Specifies the checksum type. You can specify one of the following values: - MD5, - SHA1 - SHA256. If you specify the checksum types, you must also specify the -ChecksumValue parameter. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChecksumValue</maml:name> <maml:description> <maml:para> Specifies the checksum value to be used to check the integrity and security of the uploaded file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para> When specified, the cmdlet runs as background job and returns a Job object immediately. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-LXCAOSImage</maml:name> <command:description> Imports a local device driver into the OS-images repository. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImagePath</maml:name> <maml:description> <maml:para> Specifies the file path and file name to be imported. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeviceDriver</maml:name> <maml:description> <maml:para> Indicates that the import file is a device driver. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OSImageName</maml:name> <maml:description> <maml:para> Specifies the name of the OS image to which you want to add the device driver (for example, redhat7.0). Note: The OS image must exist in the OS images repository. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para> When specified, the cmdlet runs as background job and returns a Job object immediately. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImagePath</maml:name> <maml:description> <maml:para> Specifies the file path and file name to be imported. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChecksumType</maml:name> <maml:description> <maml:para> Specifies the checksum type. You can specify one of the following values: - MD5, - SHA1 - SHA256. If you specify the checksum types, you must also specify the -ChecksumValue parameter. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChecksumValue</maml:name> <maml:description> <maml:para> Specifies the checksum value to be used to check the integrity and security of the uploaded file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeviceDriver</maml:name> <maml:description> <maml:para> Indicates that the import file is a device driver. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OSImageName</maml:name> <maml:description> <maml:para> Specifies the name of the OS image to which you want to add the device driver (for example, redhat7.0). Note: The OS image must exist in the OS images repository. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para> When specified, the cmdlet runs as background job and returns a Job object immediately. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If you specify the -AsJob parameter, this cmdlets 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> <dev:code> # # The following example imports an operating-system image into the OS-images repository in synchronous mode. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $job = Import-LXCAOSImage -ImagePath c:\ESXi-5.1.1-1065491-RTM-Lenovo-20130607-GA.iso $osimages = Get-LXCAOSImage Disconnect-LXCA </dev:code> <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> <dev:code> # # The following example imports a local OS image into the OS-images repository as a job that runs in the background and # uses a loop to wait until the job completes. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $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 Disconnect-LXCA </dev:code> <dev:remarks> <maml:para></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> <dev:code> # # The following example imports a local OS image into the OS-images repository as a job that runs in the background and # waits until the job completes. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $job = Import-LXCAOSImage -ImagePath c:\ESXi-5.1.1-1065491-RTM-Lenovo-20130607-GA.iso -AsJob -WaitForJob ToEnd $osimages = Get-LXCAOSImage Disconnect-LXCA </dev:code> <dev:remarks> <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> <maml:linkText /> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Import-LXCASwitchConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-LXCASwitchConfig</command:name> <maml:description> <maml:para> This cmdlet imports configuration-data files from the local system into Lenovo XClarity Administrator, for a specific switch. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>LXCASwitchConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet imports configuration-data files from the local system into Lenovo XClarity Administrator, for a specific switch. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-LXCASwitchConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch to associate with the imported files. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para> Specifies the full file name of the configuration-data files to import. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Comment</maml:name> <maml:description> <maml:para> Specifies the description of the configuration-data files. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch to associate with the imported files. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FilePath</maml:name> <maml:description> <maml:para> Specifies the full file name of the configuration-data files to import. Note: Files that would be imported, should not exist on XClarity Administrator; if a configuration file with the same name exists on the LXCA an exception with "Filename already exists: Change the filename" message is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Comment</maml:name> <maml:description> <maml:para> Specifies the description of the configuration-data files. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet doesn't return any 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> <dev:code> # # The following example imports the Switch1.cfg file from the local system in the c:\configdata directory and associates it with a specific device. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Import-LXCASwitchConfig -Uuid $switchId -FilePath c:\configdata\Switch1.cfg -Comment "Switch1 configuration" Disconnect-LXCA </dev:code> <dev:remarks> <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> <maml:linkText></maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Import-LXCAUpdatePackage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-LXCAUpdatePackage</command:name> <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> <command:verb>Import</command:verb> <command:noun>LXCAUpdatePackage</command:noun> <dev:version /> </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> <maml:name>Import-LXCAUpdatePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the update file to be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ApplianceUpdate</maml:name> <maml:description> <maml:para>When ApplianceUpdate is specified, the cmdlet will import a management-server update to the updates repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-LXCAUpdatePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Folder</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ApplianceUpdate</maml:name> <maml:description> <maml:para>When ApplianceUpdate is specified, the cmdlet will import a management-server update to the updates repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the update file to be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Folder</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>ApplianceUpdate</maml:name> <maml:description> <maml:para>When ApplianceUpdate is specified, the cmdlet will import a management-server update to the updates repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <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> <dev:code> # # The following example imports the firmware-update packages to the XClarity Administrator server in synchronous mode. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred Import-LXCAUpdatePackage -File c:\Lenovo_fw_bmc_gfbt60a_windows_i386.exe,c:\Lenovo_fw_bmc_gfbt60a_windows_i386.xml #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example imports all firmware-update packages that are located in the c:\updates folder # to the XClarity Administrator server as a job that runs in the background. # A wait loop is enforced while the job is still in running state. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred $job = Import-LXCAUpdatePackage -Folder c:\updates -AsJob while ($job.State -eq "Running") { Start-Sleep -Seconds 5 } #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example imports all firmware-update packages that are located in the c:\updates folder # to the XClarity Administrator server as a job that runs in the background. # The cmdlet waits until the background job is completed. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred Import-LXCAUpdatePackage -Folder c:\updates -AsJob -WaitForJob ToEnd #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example imports all management-server update packages that are located in the c:\updates folder # to the XClarity Administrator server as a job that runs in the background. # The cmdlet waits until the background job is completed. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred Import-LXCAUpdatePackage -Folder c:\updates -AsJob -ApplianceUpdate -WaitForJob ToEnd #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # The following example imports a management-server update package that is located in the c:\updates folder # to the XClarity Administrator server as a job that runs in the background and apply it. # The cmdlets will wait until the all the background jobs are completed. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred Import-LXCAUpdatePackage -Folder c:\updates -AsJob -ApplianceUpdate -WaitForJob ToEnd # Only one package can be applied at a time! $fixID = "lnvgy_sw_lxca_thinksystemrepo3-2.4.0_anyos_noarch" Install-LXCAUpdateManagementServer -FixId $fixID -AsJob -WaitForJob ToEnd #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Install-LXCAConfigPattern --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCAConfigPattern</command:name> <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> <command:verb>Install</command:verb> <command:noun>LXCAConfigPattern</command:noun> <dev:version /> </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> <maml:name>Install-LXCAConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternId</maml:name> <maml:description> <maml:para>Specifies a server pattern ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetComputeNodeId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Restart</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCAConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternId</maml:name> <maml:description> <maml:para>Specifies a server pattern ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetRackServerId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Restart</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PatternId</maml:name> <maml:description> <maml:para>Specifies a server pattern ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetComputeNodeId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetRackServerId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Restart</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigPatternDeployResult</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <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> <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> <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> <!-- Install-LXCAConfigProfile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCAConfigProfile</command:name> <maml:description> <maml:para>Deploys a server profile to a specific target system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCAConfigProfile</command:noun> <dev:version /> </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> <maml:name>Install-LXCAConfigProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileId</maml:name> <maml:description> <maml:para>Specifies a server profile ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetComputeNodeId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Restart</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCAConfigProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileId</maml:name> <maml:description> <maml:para>Specifies a server profile ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetRackServerId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Restart</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileId</maml:name> <maml:description> <maml:para>Specifies a server profile ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetComputeNodeId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetRackServerId</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Restart</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.ConfigPatternDeployResult</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <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> <dev:code> $profile = Get-LXCAConfigProfile | where {$_.ServerUuid -ieq AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA} Remove-LXCAConfigProfileFromSystem -Profile $profile Install-LXCAConfigProfile -ProfileId $profile.Id -TargetComputeNodeId BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB -restart defer </dev:code> <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> <!-- Install-LXCAOSImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCAOSImage</command:name> <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> <command:verb>Install</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> </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> <maml:name>Install-LXCAOSImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeployTask</maml:name> <maml:description> <maml:para>Specifies a list of deployment tasks. The list is created by the New-LXCADeployTask cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DeployTask[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeployTask</maml:name> <maml:description> <maml:para>Specifies a list of deployment tasks. The list is created from the New-LXCADeployTask cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DeployTask[]</command:parameterValue> <dev:type> <maml:name>DeployTask[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployResult[]</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <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> <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].MacAddresses[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 -Hostname "testServer" Install-LXCAOSImage -DeployTask $deployTask </dev:code> <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> <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].MacAddresses[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].MacAddresses[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 -Hostname "testServer2" $deployList.Add($deployTask); #deploy node $job = Install-LXCAOSImage -DeployTask $deployList -AsJob while ($job.State eq "Running") { Start-Sleep -Seconds 5 } $job.Output </dev:code> <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> <!-- Install-LXCAQuantityLicense --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCAQuantityLicense</command:name> <maml:description> <maml:para> Uploads and install one or more licenses to the Lenovo XClarity Administrator server. To install more than one license, licenses to be installed should be passed as a zip archive. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCAQuantityLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet uploads and install one or more licenses to the Lenovo XClarity Administrator server. To install more than one license, licenses to be installed should be passed as a zip archive. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LXCAQuantityLicense</maml:name> <command:description> Uploads and install one or more licenses to Lenovo XClarity Administrator. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseFile</maml:name> <maml:description> <maml:para> Specifies the full file name of the license file or the archive file upload and install. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseFile</maml:name> <maml:description> <maml:para> Specifies the full file name of the license file or the archive file upload and install. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.QuantityLicenseInstallResult</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.QuantityLicenseInstallResult object, that contains information about the operation result on the XClarity Administrator server. Note: - For XClarity Administrator version 2.6.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - This cmdlet requires XClarity Administrator v2.7.0 or later. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This example uploads and install the license from 'C:\LXCA\lxcaLicense.key' on the Lenovo XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Install-LXCAQuantityLicense -LicenseFile C:\LXCA\lxcaLicense.key # show all information about the request: $result $result.InstallInfo #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Install-LXCAStoredCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCAStoredCredential</command:name> <maml:description> <maml:para> Resolves stored credentials that are used to establish a secure connection to a managed device. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCAStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet resolves stored credentials that are used to establish a secure connection to a managed device. Use this cmdlet when a stored credential becomes expired or inoperable on a device. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LXCAStoredCredential</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the device for which stored credentials are to be resolved. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StoredCredentialId</maml:name> <maml:description> <maml:para> Specifies the ID of the stored credential to be resolved. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the device for which stored credentials are to be resolved. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StoredCredentialId</maml:name> <maml:description> <maml:para> Specifies the ID of the stored credential to be resolved. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para/> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns the status of the operation. </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> <dev:code> # # The following example resolves stored credentials for a specific device. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Install-LXCAStoredCredential -Uuid $uuid -StoredCredentialId "1531" Disconnect-LXCA </dev:code> <dev:remarks> <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-LXCAStoredCredential</maml:linkText> <maml:linkText>Add-LXCAStoredCredential</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Install-LXCATrustedCertificate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCATrustedCertificate</command:name> <maml:description> <maml:para>Resolves untrusted certificates that are used to establish a secure connection to a managed device.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCATrustedCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The install-LXCATrustedCertificate cmdlet resolves untrusted certificates that are used to establish a secure connection to a managed device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LXCATrustedCertificate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the device for which untrusted certificates are to be resolved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the device for which untrusted certificates are to be resolved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>message string</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> <dev:code> Install-LXCATrustedCertificate -Uuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA </dev:code> <dev:remarks> <maml:para>This command resolves untrusted certificates for a specific device.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <!-- Install-LXCAUpdateManagementServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCAUpdateManagementServer</command:name> <maml:description> <maml:para>Install a management-server update.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCAUpdateManagementServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Cmdlet will install a management-server update.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LXCAUpdateManagementServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <maml:description> <maml:para> Specifies the management-server updates. The FixId can be retrieved from cmdlet Get-LXCAManagementServerPackage. Note: - Only one package can be applied at a time! </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Create a scheduled job (task) for this cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Data.ScheduleObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <maml:description> <maml:para> Specifies the management-server updates. The FixId can be retrieved from cmdlet Get-LXCAManagementServerPackage. Note: - Only one package can be applied at a time! </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Job"> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Create a scheduled job (task) for this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Data.ScheduleObject</command:parameterValue> <dev:type> <maml:name>Data.ScheduleObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the AsJob parameter, Install-LXCAUpdateManagementServer 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> <dev:code> # # The following example installs an existing management-server update package at a specific time, using a schedule object. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred # Only one package can be applied at a time! $fixId = lnvgy_utl_lxca-core_2.4.0-2019xxxx_anyos_noarch $schedule = New-LXCAScheduleObj -JobName $name -OccurrenceDate (’2019-05-22 4:35 PM') Install-LXCAUpdateManagementServer -FixId $fixId -Schedule $schedule #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example installs an existing management-server update package. # The cmdlet waits until the background job is completed. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred # Only one package can be applied at a time! $fixId = lnvgy_utl_lxca-core_2.4.0-2019xxxx_anyos_noarch Install-LXCAUpdateManagementServer -FixId $fixId -WaitForJob ToEnd #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example imports a management-server update package that is located in the c:\updates folder # to the XClarity Administrator server as a job that runs in the background and apply it. # The cmdlets will wait until the all the background jobs are completed. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred Import-LXCAUpdatePackage -Folder c:\updates -AsJob -ApplianceUpdate -WaitForJob ToEnd # Only one package can be applied at a time! $fixID = "lnvgy_sw_lxca_thinksystemrepo3-2.4.0_anyos_noarch" Install-LXCAUpdateManagementServer -FixId $fixID -AsJob -WaitForJob ToEnd #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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-LXCAScheduleObj</maml:linkText> <maml:linkText>Get-LXCAManagementServerPackage</maml:linkText> <maml:linkText>Import-LXCAUpdatePackage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Install-LXCAUpdatePackage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LXCAUpdatePackage</command:name> <maml:description> <maml:para>Applies one or more firmware updates to a target system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCAUpdatePackage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Install-LXCAUpdatePackage cmdlet applies one or more firmware updates to a target system with or without the compliance policy comparison result for the target system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LXCAUpdatePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Compliance</maml:name> <maml:description> <maml:para>Specifies the system compliance policy comparison result.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemCompliance</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UpdateRule</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ActivationMode</maml:name> <maml:description> <maml:para> Specifies when to restart the target system to activate the new firmware: - 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. - 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. - Prioritized. Firmware updates on the baseboard management controller are activated immediately; all other firmware updates are activated the next time the device is restarted: the user will have to manually restart the system. Additional restarts are then performed until the update operation completes. This rule is supported only for servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OnErrorMode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceUpdate</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Create a scheduled job (task) for this cmdlet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScheduleObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCAUpdatePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Compliances</maml:name> <maml:description> <maml:para>Specifies the systems compliances result.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemCompliance[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UpdateRule</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ActivationMode</maml:name> <maml:description> <maml:para> Specifies when to restart the target system to activate the new firmware: - 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. - 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. - Prioritized. Firmware updates on the baseboard management controller are activated immediately; all other firmware updates are activated the next time the device is restarted: the user will have to manually restart the system. Additional restarts are then performed until the update operation completes. This rule is supported only for servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OnErrorMode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceUpdate</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Create a scheduled job (task) for this cmdlet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScheduleObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCAUpdatePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Compliance</maml:name> <maml:description> <maml:para>Specifies the system compliance result.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemCompliance</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <maml:description> <maml:para>Specifies the firmware updates which will be applied to the target system. The FixId can be retrieved from cmdlet Get-LXCAUpdatePackage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ActivationMode</maml:name> <maml:description> <maml:para> Specifies when to restart the target system to activate the new firmware: - 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. - 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. - Prioritized. Firmware updates on the baseboard management controller are activated immediately; all other firmware updates are activated the next time the device is restarted: the user will have to manually restart the system. Additional restarts are then performed until the update operation completes. This rule is supported only for servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OnErrorMode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceUpdate</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Create a scheduled job (task) for this cmdlet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScheduleObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCAUpdatePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComponentName</maml:name> <maml:description> <maml:para>Specifies the component name which will be applied to the target system. The component name can be retrieved from cmdlet Get-LXCAUpdatePackage.</maml:para> <maml:para>The component name should one-to-one match to the FixId in the same order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <maml:description> <maml:para>Specifies the firmware updates which will be applied to the target system. The FixId can be retrieved from cmdlet Get-LXCAUpdatePackage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ActivationMode</maml:name> <maml:description> <maml:para> Specifies when to restart the target system to activate the new firmware: - 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. - 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. - Prioritized. Firmware updates on the baseboard management controller are activated immediately; all other firmware updates are activated the next time the device is restarted: the user will have to manually restart the system. Additional restarts are then performed until the update operation completes. This rule is supported only for servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OnErrorMode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceUpdate</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Create a scheduled job (task) for this cmdlet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScheduleObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Compliance</maml:name> <maml:description> <maml:para>Specifies the system compliance result.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemCompliance</command:parameterValue> <dev:type> <maml:name>SystemCompliance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Compliances</maml:name> <maml:description> <maml:para>Specifies the systems compliances result.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemCompliance[]</command:parameterValue> <dev:type> <maml:name>SystemCompliance[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UpdateRule</maml:name> <maml:description> <maml:para> Specifies which firmware updates in the compliance policy check result will be applied to target system: - 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. - NotCompliantOnly. Only firmware that is not compliant will be updated. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <dev:type> <maml:name>SystemType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComponentName</maml:name> <maml:description> <maml:para> Specifies the component name which will be applied to the target system. The component name can be retrieved from cmdlet Get-LXCAUpdatePackage. The component name should one-to-one match to the FixId in the same order. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FixId</maml:name> <maml:description> <maml:para>Specifies the firmware updates which will be applied to the target system. The FixId can be retrieved from cmdlet Get-LXCAUpdatePackage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ActivationMode</maml:name> <maml:description> <maml:para> Specifies when to restart the target system to activate the new firmware: - 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. - 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. - Prioritized. Firmware updates on the baseboard management controller are activated immediately; all other firmware updates are activated the next time the device is restarted: the user will have to manually restart the system. Additional restarts are then performed until the update operation completes. This rule is supported only for servers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OnErrorMode</maml:name> <maml:description> <maml:para> Specifies how to handle the update error: - 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. - 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. - 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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceUpdate</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Create a scheduled job (task) for this cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScheduleObject</command:parameterValue> <dev:type> <maml:name>ScheduleObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UpdateResult</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> Install-LXCAUpdatePackage returns a job object when the AsJob parameter is used. - The UpdateResult can be retrieved from Job.Output when the job is completed. - 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> <dev:code> $complianceResult = Get-LXCASystemCompliance -SystemUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -SystemType ComputeNode $updateResult = Install-LXCAUpdatePackage -Compliance $complianceResult -UpdateRule NotCompliantOnly -ActivationMode Immediate -OnErrorMode StopOnError -AsJob </dev:code> <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> <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> <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> <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> <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:example> <maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> $ret = Install-LXCAUpdatePackage -Uuid E6D8CE72DF8011D4A54BDDDD212121F5 -SystemType RackServer -ComponentName "UEFI","Diagnostics" -FixId "lnvgy_fw_uefi_tce123i-2.10_anyos_32-64","lnvgy_fw_dsa_dsyt98i-9.03_anyos_32-64" -ActivationMode Delayed -OnErrorMode ContinueOnError -Simulation </dev:code> <dev:remarks> <maml:para>This command apply two firmware updates to the target system, without firmware compliance policy.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> $schedule = New-LXCAScheduleObj -JobName $name -OccurrenceDate ('2017-12-22 4:35 PM') $ret = Install-LXCAUpdatePackage -Uuid E6D8CE72DF8011D4A54BDDDD212121F5 -SystemType RackServer -ComponentName "UEFI","Diagnostics" -FixId "lnvgy_fw_uefi_tce123i-2.10_anyos_32-64","lnvgy_fw_dsa_dsyt98i-9.03_anyos_32-64" -ActivationMode Delayed -OnErrorMode ContinueOnError -Simulation -Schedule $schedule </dev:code> <dev:remarks> <maml:para>This command will create a scheduled job (task) to apply two firmware updates to the target system, without firmware compliance policy.</maml:para> <maml:para/> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 6 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> $complianceResult = Get-LXCASystemCompliance -Uuids "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB" -SystemType ComputeNode $updateResult = Install-LXCAUpdatePackage -Compliances $complianceResult -UpdateRule NotCompliantOnly -ActivationMode Immediate -OnErrorMode StopOnError -AsJob </dev:code> <dev:remarks> <maml:para>This command gets compliances result from two compute node and then applies all non-compliant firmware updates to those 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>Join-LXCAUpdateCompliancePolicy</maml:linkText> <maml:linkText>Get-LXCASystemCompliance</maml:linkText> <maml:linkText>Get-LXCAUpdatePackage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Invoke-LXCARestMethod --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-LXCARestMethod</command:name> <maml:description> <maml:para>Invoke a Lenovo XClarity Administrator REST API directly.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>LXCARestMethod</command:noun> <dev:version /> </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> <maml:name>Invoke-LXCARestMethod</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ResourceUrl</maml:name> <maml:description> <maml:para>Specifies the resource URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the http request method, available methods: GET, POST, PUT, DELETE, PATCH.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalHeaders</maml:name> <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> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UploadFilePath</maml:name> <maml:description> <maml:para>Specifies one or more file paths from which a file is to be uploaded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UploadFormName</maml:name> <maml:description> <maml:para>Specifies the field name in the POST method when uploading a file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCARestMethod</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ResourceUrl</maml:name> <maml:description> <maml:para>Specifies the resource URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the http request method, available methods: GET, POST, PUT, DELETE, PATCH.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalHeaders</maml:name> <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> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequestBody</maml:name> <maml:description> <maml:para>Specifies the request body (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutFile</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ResourceUrl</maml:name> <maml:description> <maml:para>Specifies the resource URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the http request method, available methods: GET, POST, PUT, DELETE, PATCH.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AdditionalHeaders</maml:name> <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> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RequestBody</maml:name> <maml:description> <maml:para>Specifies the request body (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UploadFilePath</maml:name> <maml:description> <maml:para>Specifies one or more file paths from which a file is to be uploaded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UploadFormName</maml:name> <maml:description> <maml:para>Specifies the field name in the POST method when uploading a file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutFile</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>LXCARestResponse</maml:name> <maml:uri/> <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> <maml:name>LXCARestResponseOutFile</maml:name> <maml:uri/> <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> <dev:code> $url = "/nodes" $headers = @{'Item'='10';} $restResult = Invoke-LXCARestMethod -ResourceUrl $url -Method GET -AdditionalHeaders $headers $restResult.HttpStatusCode $restResult.Headers $restResult.Body </dev:code> <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:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> $url = "compliancePolicies?action=import" $restResult = Invoke-LXCARestMethod -Method POST -ResourceUrl $url -UploadFilePath C:\cmm.xml -UploadFormName "uploadedfiles[]" $restResult.HttpStatusCode $restResult.Headers $restResult.Body </dev:code> <dev:remarks> <maml:para>This command uploads an update policy file "cmm.xml" to the management 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>None</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Invoke-LXCASystemAction --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-LXCASystemAction</command:name> <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, Flex storage canister, Flex switch, RackSwitch switch or Lenovo storage controller.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>LXCASystemAction</command:noun> <dev:version /> </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, Flex storage canister, Flex switch, RackSwitch switch or Lenovo storage controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CMMUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a CMM as the target for the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CMMAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the target CMM. -Reset </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FirmwareUpdate</maml:name> <maml:description> <maml:para>When FirmwareUpdate is specified, the cmdlets perform power actions during a firmware update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Flex System compute node as the target for the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeAction</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FirmwareUpdate</maml:name> <maml:description> <maml:para>When FirmwareUpdate is specified, the cmdlets perform power actions during a firmware update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CanisterUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a storage canister as the target for the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CanisterAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the target storage canister. -PowerOn -PowerOff -Restart </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IOSwitchUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IOSwitchAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the target I/O module. -PowerOn -PowerOff -Reset </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FirmwareUpdate</maml:name> <maml:description> <maml:para>When FirmwareUpdate is specified, the cmdlets perform power actions during a firmware update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a System x server as the target for the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerAction</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FirmwareUpdate</maml:name> <maml:description> <maml:para>When FirmwareUpdate is specified, the cmdlets perform power actions during a firmware update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a ThinkServer server as the target for the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerAction</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FirmwareUpdate</maml:name> <maml:description> <maml:para>When FirmwareUpdate is specified, the cmdlets perform power actions during a firmware update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a RackSwitch switch as the target for the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the target RackSwitch switch. -Restart </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FirmwareUpdate</maml:name> <maml:description> <maml:para>When FirmwareUpdate is specified, the cmdlets perform power actions during a firmware update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCASystemAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Lenovo Storage system on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ControllerId</maml:name> <maml:description> <maml:para> Specifies the controller on which you want to take action. This can be one of the following values: -A. Top controller -B. Bottom controller </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified Lenovo Storage system. -PowerOn -PowerOff -Restart </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CMMUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a CMM on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CMMAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified CMM. You can specify one of the following actions: -Reset </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Flex System compute node on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified Flex System compute node. You can specify one of the following actions: -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -VirtualReseat </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CanisterUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a storage canister on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CanisterAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified storage canister. You can specify one of the following actions: -PowerOn -PowerOff -Restart </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IOSwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Flex switch on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IOSwitchAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified Flex switch. You can specify one of the following actions: -PowerOn -PowerOff -Reset </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a System x server on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified System x server. You can specify one of the following actions: -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -ReseatIMM </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a ThinkServer server on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified ThinkServer server. You can specify one of the following actions: -PowerOn -PowerOff -Restart -ShutdownOSandPowerOff -ShutdownOSandRestart -RestartWithNMI (Non-maskable Interrupt) -ReseatBMC </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a RackSwitch switch on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified RackSwitch switch. You can specify one of the following actions: -Restart </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Lenovo Storage system on which to perform the system action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ControllerId</maml:name> <maml:description> <maml:para> Specifies the controller on which you want to take action. This can be one of the following values: - A. Top controller - B. Bottom controller </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAction</maml:name> <maml:description> <maml:para> Specifies the action to be performed on the specified Lenovo Storage system. You can specify one of the following actions: -PowerOn -PowerOff -Restart </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FirmwareUpdate</maml:name> <maml:description> <maml:para>When FirmwareUpdate is specified, the cmdlets perform power actions during a firmware update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>When Force is specified, the cmdlet performs the system action without first prompting for confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> Invoke-LXCASystemAction -ComputeNodeUuid AAAAAAAAAAAA -ComputeNodeAction PowerOn -Force </dev:code> <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> <!-- Join-LXCAUpdateCompliancePolicy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Join-LXCAUpdateCompliancePolicy</command:name> <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> <command:verb>Join</command:verb> <command:noun>LXCAUpdateCompliancePolicy</command:noun> <dev:version /> </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> <maml:name>Join-LXCAUpdateCompliancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Policy</maml:name> <maml:description> <maml:para>Specifies the update compliance policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CompliancePolicy</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Join-LXCAUpdateCompliancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies the name of the update compliance policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Policy</maml:name> <maml:description> <maml:para>Specifies the update compliance policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CompliancePolicy</command:parameterValue> <dev:type> <maml:name>CompliancePolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PolicyName</maml:name> <maml:description> <maml:para>Specifies the name of update compliance policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SystemType</maml:name> <maml:description> <maml:para> Specifies the type of the target system. The type can be one of the following values: - CMM. The specified device is a CMM. - ComputeNode. The specified device is a Flex System compute node. - IOSwitch. The specified device is a Flex System switch. - RackServer. The specified device is a rack or tower server. - RackSwitch. The specified device is a RackSwitch switch. - Storage. The specified device is a storage device. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SystemType</command:parameterValue> <dev:type> <maml:name>SystemType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.SystemCompliance</maml:name> <maml:uri/> <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> <dev:code> $policy= Get-LXCAUpdateCompliancePolicy $complianceResult = Join-LXCAUpdateCompliancePolicy -Policy $policy[0] -SystemUuid 2B885CEB5B6711E1A12B5CF3FC11314A -SystemType ComputeNode </dev:code> <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> <!-- New-LXCADeployTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-LXCADeployTask</command:name> <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> <command:verb>New</command:verb> <command:noun>LXCADeployTask</command:noun> <dev:version /> </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> <maml:name>New-LXCADeployTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageProfileID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConfigFileID</maml:name> <maml:description> <maml:para> ID of the custom configuration-settings file to use for this OS deployment. Required if ImageProfileID includes a custom configuration-settings file; otherwise ignored. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UnattendedFileID</maml:name> <maml:description> <maml:para> ID of the unattend file to use for this OS deployment. Required if selectedImage includes custom unattend files; otherwise ignored. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetDevice</maml:name> <maml:description> <maml:para> Specifies the device on target node where the OS image will be deployed. This can be one of the following: - LocalDisk. Use the local disk drive: the first enumerated local disk drive in the managed server is used. - M.2drive. Use M.2 drive: the first enumerated M.2 drive in the managed server is used. - EmbeddedHypervisor. Use embedded hypervisor (USB or SD media adapter) when ESXi is selected. - SanDisk. Use SAN volumes if available. The SAN ID is required if the sandisk is selected. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SanID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WindowsDomain</maml:name> <maml:description> <maml:para> Windows only: Active Directory domain that the Windows operating system is to join after the operating system is deployed successfully. If an OU is present, specify the string using the format domain/ou. If the operating system will not join a domain, you can set this field to null. Note 1: - Use the ADUserName and ADPassword parameters to specify the user name and password for the domain. Note 2: - To join an Active Directory domain, you must specify either the WindowsDomain or WindowsDomainBlob parameter. If both are specified, the WindowsDomainBlob parameter is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ADUserName</maml:name> <maml:description> <maml:para> Windows only: User name for the Active Directory domain that is specified in the WindowsDomain field Note: - This parameter is required if you want a Windows operating system to join an Active Directory domain. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ADPassword</maml:name> <maml:description> <maml:para> Windows only: Password for the Active Directory user name (ADUserName field). Note: - This parameter is required if you want a Windows operating system to join an Active Directory domain. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WindowsDomainBlob</maml:name> <maml:description> <maml:para> Windows only: Active Directory Computer Account Metadata (in Base-64 encoded blob format) that can be used to join the Active Directory domain. For instructions for generating a file that contains the metadata blob data, see Integrating with Windows Active Directory page at https://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca_restapis.doc/integrating_with_active_directory.html Note: - To join an Active Directory domain, you must specify either the windowsDomain or windowsDomainBlob parameter. If both are specified, the windowsDomainBlob parameter is used. - You can use metadata blob data when deploying any Windows operating system. However, this method must be used for Windows Nano Server. Specifying a domain in global settings is not supported for Windows Nano Server. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseKey</maml:name> <maml:description> <maml:para>Specifies the license key that is needed for Windows and ESXi OS installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MacAddress</maml:name> <maml:description> <maml:para> Specifies the host MAC address to which the IP address will be bound. For Lenovo XClarity Administrator v1.2.0 or later, you can also specify AUTO to automatically detect the first Ethernet port that can be configured and used for deployment. </maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IpAddress</maml:name> <maml:description> <maml:para> Specifies the IP address after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para> Specifies the subnet mask of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GateWay</maml:name> <maml:description> <maml:para> Specifies the gateway of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DNS1</maml:name> <maml:description> <maml:para> Specifies the first DNS server of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DNS2</maml:name> <maml:description> <maml:para> Specifies the second DNS server of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Mtu</maml:name> <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> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para> Specifies the hostname for the host server. If a hostname is not specified, a default hostname is assigned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PrefixLength</maml:name> <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> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VlanId</maml:name> <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> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageProfileID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConfigFileID</maml:name> <maml:description> <maml:para> ID of the custom configuration-settings file to use for this OS deployment. Required if ImageProfileID includes a custom configuration-settings file; otherwise ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UnattendedFileID</maml:name> <maml:description> <maml:para> ID of the unattend file to use for this OS deployment. Required if selectedImage includes custom unattend files; otherwise ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TargetDevice</maml:name> <maml:description> <maml:para> Specifies the device on target node where the OS image will be deployed. This can be one of the following: - LocalDisk. Use the local disk drive: the first enumerated local disk drive in the managed server is used. - M.2drive. Use M.2 drive: the first enumerated M.2 drive in the managed server is used. - EmbeddedHypervisor. Use embedded hypervisor (USB or SD media adapter) when ESXi is selected. - SanDisk. Use SAN volumes if available. The SAN ID is required if the sandisk is selected. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SanID</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WindowsDomain</maml:name> <maml:description> <maml:para> Windows only: Active Directory domain that the Windows operating system is to join after the operating system is deployed successfully. If an OU is present, specify the string using the format domain/ou. If the operating system will not join a domain, you can set this field to null. Note 1: - Use the ADUserName and ADPassword parameters to specify the user name and password for the domain. Note 2: - To join an Active Directory domain, you must specify either the WindowsDomain or WindowsDomainBlob parameter. If both are specified, the WindowsDomainBlob parameter is used. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ADUserName</maml:name> <maml:description> <maml:para> Windows only: User name for the Active Directory domain that is specified in the WindowsDomain field Note: - This parameter is required if you want a Windows operating system to join an Active Directory domain. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ADPassword</maml:name> <maml:description> <maml:para> Windows only: Password for the Active Directory user name (ADUserName field). Note: - This parameter is required if you want a Windows operating system to join an Active Directory domain. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WindowsDomainBlob</maml:name> <maml:description> <maml:para> Windows only: Active Directory Computer Account Metadata (in Base-64 encoded blob format) that can be used to join the Active Directory domain. For instructions for generating a file that contains the metadata blob data, see Integrating with Windows Active Directory page at https://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca_restapis.doc/integrating_with_active_directory.html Note: - To join an Active Directory domain, you must specify either the windowsDomain or windowsDomainBlob parameter. If both are specified, the windowsDomainBlob parameter is used. - You can use metadata blob data when deploying any Windows operating system. However, this method must be used for Windows Nano Server. Specifying a domain in global settings is not supported for Windows Nano Server. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseKey</maml:name> <maml:description> <maml:para>Specifies the license key that is needed for Windows and ESXi OS installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MacAddress</maml:name> <maml:description> <maml:para> Specifies the host MAC address to which the IP address will be bound. For Lenovo XClarity Administrator v1.2.0 or later, you can also specify AUTO to automatically detect the first Ethernet port that can be configured and used for deployment. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IpAddress</maml:name> <maml:description> <maml:para> Specifies the IP address after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para> Specifies the subnet mask of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GateWay</maml:name> <maml:description> <maml:para> Specifies the gateway of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DNS1</maml:name> <maml:description> <maml:para> Specifies the first DNS server of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DNS2</maml:name> <maml:description> <maml:para> Specifies the second DNS server of the network after OS deployment. It is required if a static IP address was chosen when the global settings were defined. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Mtu</maml:name> <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> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specifies the hostname for the host server. If a hostname is not specified, a default hostname is assigned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PrefixLength</maml:name> <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> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VlanId</maml:name> <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> <command:parameterValue required="true" variableLength="false">Long</command:parameterValue> <dev:type> <maml:name>Long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.DeployTask</maml:name> <maml:uri/> <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> <dev:code> $nodes = Get-LXCADeployableServer $images = Get-LXCAOSImage | where {$_.Name -contains "esxi5.5"} $deploytask = New-LXCADeployTask -ServerUuid $nodes[0].Uuid -ImageProfileID $images[0].Profiles[0].Id -TargetDevice "LocalDisk" -MacAddress $nodes[0].MacAddresses[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 -Hostname "testServer" Install-LXCAOSImage -DeployTask $deploytask </dev:code> <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:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> $nodes = Get-LXCADeployableServer $image = "esxi6.7_1.28|20181205102133_Custom-Unattend" $unattendedFileID = "20181205102110_ESXi_customUnattend.cfg" $deploytask = New-LXCADeployTask -ServerUuid $nodes[0].Uuid -ImageProfileID $image -UnattendedFileID $unattendedFileID -TargetDevice "LocalDisk" -MacAddress $nodes[0].MacAddresses[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 -Hostname "testServer" Install-LXCAOSImage -DeployTask $deploytask </dev:code> <dev:remarks> <maml:para>This example creates a deploy task and deploy a custom OS image with an unattend file to use for this OS 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>Install-LXCAOSImage</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- New-LXCAScheduleObj --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-LXCAScheduleObj</command:name> <maml:description> <maml:para>Creates a local schedule object that can be used by certain cmdlets to create a scheduled job on LXCA.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>LXCAScheduleObj</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-LXCAScheduleObj cmdlet will create a local schedule object, which can be used with certain cmdlets to create a scheduled job on LXCA.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-LXCAScheduleObj</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies schedule name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OccurrenceDate</maml:name> <maml:description> <maml:para>Specifies schedule occurrence date.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="JobName"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies schedule name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="ExecDate"> <maml:name>OccurrenceDate</maml:name> <maml:description> <maml:para>Specifies schedule occurrence date.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Data.ScheduleObject</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Data.ScheduleObject</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> <dev:code> # # The following example creates a ScheduleObject with a specific date and time. $scheduleName = "Update-Package-Install" $schedule = New-LXCAScheduleObj -ScheduleName $scheduleName -OccurrenceDate ('2019-12-22 4:35 PM') # Now, use Schedule Object in Install-LXCAUpdateManagementServer cmdlet. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Port 443 -Credential $cred $fixId = lnvgy_utl_lxca-core_2.4.0-2019xxxx_anyos_noarch Install-LXCAUpdateManagementServer -FixId $fixId -Schedule $schedule #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <maml:para></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> <dev:code> # # The following example creates a ScheduleObject based on Get-Date cmdlet. $schedule = New-LXCAScheduleObj -ScheduleName $name -OccurrenceDate (Get-Date).AddDays(1) # the schedule object can be used as in 'EXAMPLE 1': the Update Management Server job will start tomorrow. </dev:code> <dev:remarks> <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> <maml:linkText></maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Remove-LXCABackup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCABackup</command:name> <maml:description> <maml:para> Delete a Lenovo XClarity Administrator backup. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCABackup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> Use this cmdlet to delete a Lenovo XClarity Administrator backup from a specific location. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCABackup</maml:name> <command:description> Delete a Lenovo XClarity Administrator backup from all locations or from internal location. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> UUID of the backup to be deleted. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Location from where to delete the backup. This can be one of the following value: - All - deletes the backup from all locations (XClarity Administrator local repository and remote shares). - Internal - deletes the backup in the XClarity Administrator local repository. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCABackup</maml:name> <command:description> Delete a Lenovo XClarity Administrator backup from aremote share location. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> UUID of the backup to be deleted. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SharedLocation</maml:name> <maml:description> <maml:para> The mounting point of the configured remote share from where to delete the backup. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> UUID of the backup to be downloaded. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Location from where to delete the backup. This can be one of the following value: - All - deletes the backup from all locations (XClarity Administrator local repository and remote shares). - Internal - deletes the backup in the XClarity Administrator local repository. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SharedLocation</maml:name> <maml:description> <maml:para> The mounting point of the configured remote share from where to delete the backup. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RequestResult</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.RequestResult object that contains information about the backup delete process. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # The following example deletes an existing backup from the XClarity Administrator server internal repository. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Remove-LXCABackup -Uuid c4e24aab-7f56-4474-99f4-a81c676df128 -Location Internal # show all the information about the request: # - Result value, # - Message if any, $result | Format-List #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example deletes an existing backup from a configured remote share. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Remove-LXCABackup -Uuid c4e24aab-7f56-4474-99f4-a81c676df128 -SharedLocation '/mnt/sharedFolder' # show all the information about the request: # - Result value, # - Message if any, $result | Format-List #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Remove-LXCAConfigProfileFromSystem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAConfigProfileFromSystem</command:name> <maml:description> <maml:para>Removes (deactivate) a server profile from assignment to an associated system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCAConfigProfileFromSystem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-LXCAConfigProfileFromSystem cmdlet removes (deactivate) 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> <maml:name>Remove-LXCAConfigProfileFromSystem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Profile</maml:name> <maml:description> <maml:para>Server profile object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove (deactivate) the profile even if the target system is not reachable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCAConfigProfileFromSystem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileID</maml:name> <maml:description> <maml:para>Server profile ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove (deactivate) the profile even if the target system is not reachable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Profile</maml:name> <maml:description> <maml:para>Server profile object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigProfile</command:parameterValue> <dev:type> <maml:name>ConfigProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileId</maml:name> <maml:description> <maml:para>Server profile ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove (deactivate) the profile even if the target system is not reachable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>ConfigProfile</maml:name> <maml:uri/> <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> <maml:name>No</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCAConfigProfileFromSystem 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> <dev:code> $profiles = Get-LXCAConfigProfile | where{$_.status -eq "ASSIGNED"} Remove-LXCAConfigProfileFromSystem -ProfileId $profiles[0].Id </dev:code> <dev:remarks> <maml:para>This command removes (deactivates) 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> <!-- Remove-LXCAEventExclusionFilter --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAEventExclusionFilter</command:name> <maml:description> <maml:para>Deletes an event exclusion filter.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCAEventExclusionFilter</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-LXCAEventExclusionFilter cmdlet deletes an event exclusion filter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCAEventExclusionFilter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FilterID</maml:name> <maml:description> <maml:para>Specifies the ID of the exclusion filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FilterID</maml:name> <maml:description> <maml:para>Specifies the ID of the exclusion filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> Remove-LXCAEventExclusionFilter -FilterID "AUG:XFT:1" </dev:code> <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> <!-- Remove-LXCAJobNotes --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAJobNotes</command:name> <maml:description> <maml:para> Removes all notes from a specific job (task). </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCAJobNotes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet removes all notes from a specific job (task). Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCAJobNotes</maml:name> <command:description> Removes all notes from a specific job (task). </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>JobUID</maml:name> <maml:description> <maml:para> Specifies the UID of the job. If the job does not exist, "404 - Not Found" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>JobUID</maml:name> <maml:description> <maml:para> Specifies the UID of the job. If the job does not exist, "404 - Not Found" exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet doesn't return any 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> <dev:code> # # The following example delete all notes from a specific job. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $jobUID = 123444 Remove-LXCAJobNotes -JobUID $jobUID Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Remove-LXCAManagedDevice --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAManagedDevice</command:name> <maml:description> <maml:para>Removes one or more devices (chassis, rack server, think server, rack switch or Lenovo storage) from management by the Lenovo XClarity Administrator server (unmanages devices). </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCAManagedDevice</command:noun> <dev:version /> </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> <maml:name>Remove-LXCAManagedDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUIDs of the RackSwitch switches that are to be unmanaged by Lenovo XClarity Administrator. The RackSwitch switches must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para>Specifies the UUIDs of the Lenovo Storage systems that are to be unmanaged by Lenovo XClarity Administrator. The Lenovo Storage system must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceUnmanage</maml:name> <maml:description> <maml:para>Force unmanage even if the endpoint is not reachable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUIDs of the RackSwitch switches that are to be unmanaged by Lenovo XClarity Administrator. The RackSwitch switches must have been managed by Lenovo XClarity Administrator previously.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para>Specifies the UUIDs of the Lenovo Storage systems that are to be unmanaged by Lenovo XClarity Administrator. The Lenovo Storage system must have been managed by the Lenovo XClarity Administrator previously.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceUnmanage</maml:name> <maml:description> <maml:para>Force unmanage even if the endpoint is not reachable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <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> <dev:code> $managedchassis = Get-LXCAChassis $chassisUuids = @() Foreach($chassis in $managedchassis) { $chassisUuids += $chassis.Uuid } Remove-LXCAManagedDevice -ChassisUuid $chassisUuids </dev:code> <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> <dev:code> $chassis = Get-LXCAChassis $job = Remove-LXCAManagedDevice -ChassisUuid $chassis[0].Uuid -AsJob while ($job.State -eq "Running") { Start-Sleep -Seconds 5 } </dev:code> <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> <!-- Remove-LXCAOSImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAOSImage</command:name> <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> <command:verb>Remove</command:verb> <command:noun>LXCAOSImage</command:noun> <dev:version /> </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> <maml:name>Remove-LXCAOSImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageID</maml:name> <maml:description> <maml:para>Specifies the image ID. The cmdlet removes the operating system image and its image profiles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCAOSImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>OSImage</maml:name> <maml:description> <maml:para>Specifies the operating system image. The cmdlet removes the image and its image profiles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OSImage</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCAOSImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileID</maml:name> <maml:description> <maml:para>Specifies the image profile ID. The cmdlet removes the image profile from the image repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ImageID</maml:name> <maml:description> <maml:para>Specifies the image ID. The cmdlet removes the operating system image and its image profiles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>OSImage</maml:name> <maml:description> <maml:para>Specifies the operating system image. The cmdlet removes the image and its image profiles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OSImage</command:parameterValue> <dev:type> <maml:name>OSImage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ProfileID</maml:name> <maml:description> <maml:para>Specifies the image profile ID. The cmdlet removes the image profile from the image repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <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> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.OSImage</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> $images = Get-LXCAOSImage Remove-LXCAOSImage -OSImage $images[0] </dev:code> <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> <!-- Remove-LXCAQuantityLicense --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAQuantityLicense</command:name> <maml:description> <maml:para> Removes a specific license from Lenovo XClarity Administrator. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCAQuantityLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet removes a specific license from Lenovo XClarity Administrator. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCAQuantityLicense</maml:name> <command:description> Removes a specific license from Lenovo XClarity Administrator. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseId</maml:name> <maml:description> <maml:para> Specifies the Id of the license to be removed from the Lenovo XClarity Administrator server. Note: - You can retrieve the license Id using Get-LXCAQuantityLicense. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LicenseId</maml:name> <maml:description> <maml:para> Specifies the Id of the license to be removed from the Lenovo XClarity Administrator server. Note: - You can retrieve the license Id using Get-LXCAQuantityLicense. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>int</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RequestResult</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.RequestResult object, that contains information about the operation result on the XClarity Administrator server. Note: - For XClarity Administrator version 2.7.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - This cmdlet requires XClarity Administrator v2.8.0 or later. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This example removes the license with id 3 from the Lenovo XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Remove-LXCAQuantityLicense -LicenseId 3 # show all information about the request: $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This example removes all installed licenses from the Lenovo XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $license = Get-LXCAQuantityLicense foreach($item in $license.Licenses) { $(Remove-LXCAQuantityLicense -LicenseId $item.Id) } #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Remove-LXCARack --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCARack</command:name> <maml:description> <maml:para>This cmdlet deletes a specific rack.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCARack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet deletes a specific rack. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCARack</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the rack to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCARack</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Rack</maml:name> <maml:description> <maml:para>Specifies the rack object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Rack</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the rack to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Rack</maml:name> <maml:description> <maml:para>Specifies the rack object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Rack</command:parameterValue> <dev:type> <maml:name>Rack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.Rack</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCARack 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> <dev:code> # # The following example deletes the rack with UUID AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Remove-LXCARack -RackUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Remove-LXCARackItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCARackItem</command:name> <maml:description> <maml:para>This cmdlet removes an managed endpoint from a specific rack.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCARackItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet removes an managed endpoint from a specific rack. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCARackItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed endpoint to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCARackItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexId</maml:name> <maml:description> <maml:para>Specifies the ID of the scalable-complex system to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed endpoint to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexId</maml:name> <maml:description> <maml:para>Specifies the ID of the scalable-complex system to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Remove-LXCARackItem 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> <dev:code> # # The following example removes a managed device with UUID BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB from rack with UUID AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Credential $cred Remove-LXCARack -RackUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -RackItemUuid BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Remove-LXCARoleGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCARoleGroup</command:name> <maml:description> <maml:para>This cmdlet deletes a role group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCARoleGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet deletes a role group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCARoleGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupName</maml:name> <maml:description> <maml:para>Specifies one role group name of the role group to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupName</maml:name> <maml:description> <maml:para>Specifies one role group name of the role group to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns result message.</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> <dev:code> Remove-LXCARoleGroup -RoleGroupName $name </dev:code> <dev:remarks> <maml:para>This command will be delete Specifies the role group.</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> <!-- Remove-LXCASchedule --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCASchedule</command:name> <maml:description> <maml:para>This cmdlet deletes a schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCASchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet deletes a schedule.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCASchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies one or more schedule name of the rack to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCASchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedules</maml:name> <maml:description> <maml:para>Specifies the schedules object to be deleted. Get it through a command [Get-LXCASchedule]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Data.ScheduleShowDTO[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ScheduleNames</maml:name> <maml:description> <maml:para>Specifies one or more schedule name of the rack to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Schedules</maml:name> <maml:description> <maml:para>Specifies the schedules object to be deleted. Get it through a command [Get-LXCASchedule]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Data.ScheduleShowDTO[]</command:parameterValue> <dev:type> <maml:name>Data.ScheduleShowDTO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <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> <dev:code> Remove-LXCASchedule -ScheduleNames $name </dev:code> <dev:remarks> <maml:para>This command will be delete Specifies the schedules.</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> <dev:code> $schedule = Get-LXCASchedule Remove-LXCASchedule -Schedules $schedule[0] </dev:code> <dev:remarks> <maml:para>This command will be delete Specifies the schedules.</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-LXCASchedule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Remove-LXCAStoredCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAStoredCredential</command:name> <maml:description> <maml:para> Deletes a stored credential from the Lenovo XClarity Administrator server. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCAStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet removes a stored credential from the XClarity Administrator server. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCAStoredCredential</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para> Specifies the stored credential ID to be deleted. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para> Specifies the stored credential ID to be deleted. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet 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> <dev:code> # # The following example deletes a stored credential. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Remove-LXCAStoredCredential -Id "1523" Disconnect-LXCA </dev:code> <dev:remarks> <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-LXCAStoredCredential</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Remove-LXCASwitchConfigFile --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCASwitchConfigFile</command:name> <maml:description> <maml:para> This cmdlet deletes one or more switch configuration-data files from Lenovo XClarity Administrator. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCASwitchConfigFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet deletes one or more switch configuration-data files from Lenovo XClarity Administrator. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCASwitchConfigFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data files to delete. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch that is associated with the configuration-data files. Note: This parameter is required if the more than one switch have configuration-data files with the same name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data files to delete. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch that is associated with the configuration-data files. Note: This parameter is required if the more than one switch have configuration-data files with the same name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns the operation result.</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> <dev:code> # # This command deletes switch configurations with filenames $name1,$name2 $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Remove-LXCASwitchConfigFile -FileName $name1,$name2) Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This command deletes switch configurations with filenames $name1,$name2 from a specific switch. # use -Uuid parameter when more than one switch have configuration-data files with the same name. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Remove-LXCASwitchConfigFile -FileName $name1,$name2 -Uuid $uuid) Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Remove-LXCATask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCATask</command:name> <maml:description> <maml:para> Deletes one or more tasks (jobs) on the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCATask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet deletes one or more tasks (jobs) from the Lenovo XClarity Administrator server. Each task must be in a stopped, cancelled, or complete state before it can be removed. Not all tasks can be deleted. This cmdlet deletes only tasks for which the isDeletable attribute is set to true. Task IDs are returned for only the tasks that were deleted. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCATask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskID"> <maml:name>TaskUIDs</maml:name> <maml:description> <maml:para> Specifies one or more task IDs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -JobID -TaskId -TaskUID </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-LXCATask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Tasks</maml:name> <maml:description> <maml:para> Specifies one or more task instances. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -Job -Task </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskID"> <maml:name>TaskUIDs</maml:name> <maml:description> <maml:para> Specifies one or more task IDs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -JobID -TaskId -TaskUID </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Tasks</maml:name> <maml:description> <maml:para> Specifies one or more task instances. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -Job -Task </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet removes one or more tasks from the XClarity Administrator server and returns the task UIDs of the deleted jobs as an array of strings. If none of the specified tasks can be deleted, the returned object is an empty array. </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> <dev:code> # # The following example deletes all tasks that are not currently running from the XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $tasks = Get-LXCATask -State Cancelled,CancelledWithError,CancelledWithWarning,Complete,CompleteWithError,CompleteWithWarning $tasksUIDS = Remove-LXCATask -Tasks $tasks Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Remove-LXCAUserAccount --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LXCAUserAccount</command:name> <maml:description> <maml:para>Deletes a user account from the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-LXCAUserAccount cmdlet removes a user account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCAUserAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>UserAccount</maml:name> <maml:description> <maml:para>Specifies the user account to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Removes the user account without first prompting for confirmation about the removal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>UserAccount</maml:name> <maml:description> <maml:para>Specifies the user account to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> <dev:type> <maml:name>UserAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Removes the user account without first prompting for confirmation about the removal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> $account = Get-LXCAUserAccount | where { $_.UserName -eq "testuser" } Remove-LXCAUserAccount -UserAccount $account -Force </dev:code> <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> <!-- Restore-LXCASwitchConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restore-LXCASwitchConfig</command:name> <maml:description> <maml:para> This cmdlet restore configuration data for a RackSwitch or Flex System switch. The switch configuration-data file is downloaded from Lenovo XClarity Administrator to the target switch, and the configuration takes effect automatically. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>LXCASwitchConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet restore configuration data for a RackSwitch or Flex System switch. The switch configuration-data file is downloaded from Lenovo XClarity Administrator to the target switch, and the configuration takes effect automatically. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-LXCASwitchConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data file to restore. Note: - If the configuration-data file does not exist on the XClarity Administrator, an exception is thrown. - If -Uuid is not specified and there are more than one configuration file with specified name, an exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switches to be restored. Note: This parameter is required if the more than one switch have configuration-data file with the same name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para> Specifies the name of the configuration-data file to restore. Note: - If the configuration-data file does not exist on the XClarity Administrator, an exception is thrown. - If -Uuid is not specified and there are more than one configuration file with specified name, an exception is thrown. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switches to be restored. Note: This parameter is required if the more than one switch have configuration-data file with the same name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns the operation result.</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> <dev:code> # # This command restore configurations data with filename $name $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Restore-LXCASwitchConfigFile -FileName $name) Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # This command restore configurations data with filename $name from a specific switch. # use -Uuid parameter when more than one switch have configuration-data file with the same name. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Restore-LXCASwitchConfigFile -FileName $name -Uuid $uuid) Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Set-LXCADeployGlobalSetting --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCADeployGlobalSetting</command:name> <maml:description> <maml:para>Sets the global settings used for operating system deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCADeployGlobalSetting</command:noun> <dev:version /> </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> <maml:name>Set-LXCADeployGlobalSetting</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeployGlobalSetting</maml:name> <maml:description> <maml:para>Specifies the global deploy settings which includes IP assignment type and deploy credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DeployGlobalSetting</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DeployGlobalSetting</maml:name> <maml:description> <maml:para>Specifies the global deploy setting which includes IP assignment type and deploy credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DeployGlobalSetting</command:parameterValue> <dev:type> <maml:name>DeployGlobalSetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> $setting = Get-LXCADeployGlobalSetting $setting.IpAssignment = "dhcpv4" # staticv4 / dhcpv4 Set-LXCADeployGlobalSetting -DeployGlobalSetting $setting </dev:code> <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> <!-- Set-LXCADeviceMaintenance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCADeviceMaintenance</command:name> <maml:description> <maml:para> Modifies maintenance status and schedules for a specific device. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCADeviceMaintenance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet modifies maintenance status and schedules for a specific device. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCADeviceMaintenance</maml:name> <command:description> Modifies the maintenance status of one device. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UUID</maml:name> <maml:description> <maml:para> Specifies the UUID of the device to modify the maintenance status. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Maintenance</maml:name> <maml:description> <maml:para> Specifies the new maintenance status of the device. You can specify one of the following values: - Enabled - Disabled </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EndTime</maml:name> <maml:description> <maml:para> Specifies when the device maintenance will end. - If EndTime is not specified and new Maintenance value is Enabled, the device remains in maintenance until the maintenance will be disabled. - If new maintenance value is Disabled, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartTime</maml:name> <maml:description> <maml:para> Specifies when the device maintenance will start. - If StartTime is not specified and new Maintenance value is Enabled, the device goes in maintenance immediately. - If new maintenance value is Disabled, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UUID</maml:name> <maml:description> <maml:para> Specifies the UUID of the device to check the maintenance status. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Maintenance</maml:name> <maml:description> <maml:para> Specifies the new maintenance status of the device. You can specify one of the following values: - Enabled - Disabled </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EndTime</maml:name> <maml:description> <maml:para> Specifies when the device maintenance will end. - If EndTime is not specified and new Maintenance value is Enabled, the device remains in maintenance until the maintenance will be disabled. - If new maintenance value is Disabled, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StartTime</maml:name> <maml:description> <maml:para> Specifies when the device maintenance will start. - If StartTime is not specified and new Maintenance value is Enabled, the device goes in maintenance immediately. - If new maintenance value is Disabled, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet doesn't return any 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> <dev:code> # # The following example put one device in maintenance for 3 hours, starting 2 hours from now. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $deviceUUID = "000123444" Set-LXCADeviceMaintenance -UUID $deviceUUID -Maintenance Enabled -StartTime (Get-Date).AddHours(2) -EndTime (Get-Date).AddHours(5) Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Set-LXCAEncapsulation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCAEncapsulation</command:name> <maml:description> <maml:para>Enable or disable the global encapsulation setting on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCAEncapsulation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-LXCAEncapsulation cmdlet enables or disables the global encapsulation setting on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCAEncapsulation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EnableEncapsulation</maml:name> <maml:description> <maml:para>True to enable the global encapsulation setting and false to disable it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EnableEncapsulation</maml:name> <maml:description> <maml:para>True to enable the global encapsulation setting and false to disable it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCAEncapsulation 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> <dev:code>Set-LXCAEncapsulation -EnableEncapsulation $true</dev:code> <dev:remarks> <maml:para>This command enables the encapsulation setting 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> <!-- Set-LXCALicenseWarningPeriod --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCALicenseWarningPeriod</command:name> <maml:description> <maml:para> Set the license warning period value on the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCALicenseWarningPeriod</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet modifies the license warning period, which determines the number of days before a license expires when Lenovo XClarity Administrator triggers a warning. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCALicenseWarningPeriod</maml:name> <command:description> Set the license warning period value on the Lenovo XClarity Administrator server. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WarningPeriod</maml:name> <maml:description> <maml:para> Specifies the value for the warning period to set on the XClarity Administrator server. The value can be from 1 - 270. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WarningPeriod</maml:name> <maml:description> <maml:para> Specifies the value for the warning period to set on the XClarity Administrator server. The value should be between 1 and 270. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>int</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.RequestResult</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.RequestResult object, that contains information about the operation result on the XClarity Administrator server. Note: - For XClarity Administrator version 2.8.0 or earlier, the NotSupportedException exception is thrown. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. - This cmdlet requires XClarity Administrator v3.0.0 or later. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # This example set the license warning period on the Lenovo XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Set-LXCALicenseWarningPeriod -WarningPeriod 149 # show all information about the request: $result #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Set-LXCAPSLogLevel --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCAPSLogLevel</command:name> <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> <command:verb>Set</command:verb> <command:noun>LXCAPSLogLevel</command:noun> <dev:version /> </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> <maml:name>Set-LXCAPSLogLevel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LogLevel</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LogLevel</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> Set-LXCAPSLogLevel -LogLevel Debug </dev:code> <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> <!-- Set-LXCARack --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCARack</command:name> <maml:description> <maml:para>This cmdlet modifies properties for a specific rack.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCARack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet modifies properties for a specific rack. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCARack</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the rack to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of rack. The name must be unique and have the length between 1 and 256 characters. Allowed characters for the rack name are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the location of the rack. The location should have the length between 1 and 256 characters. Allowed characters for the rack location are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Room</maml:name> <maml:description> <maml:para> Specifies the room where the rack is located. The room should have the length between 1 and 256 characters. Allowed characters for the rack room are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the rack to be modified. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of rack. The name must be unique and have the length between 1 and 256 characters. Allowed characters for the rack name are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the location of the rack. The location should have the length between 1 and 256 characters. Allowed characters for the rack location are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Room</maml:name> <maml:description> <maml:para> Specifies the room where the rack is located. The room should have the length between 1 and 256 characters. Allowed characters for the rack room are: alpha-numeric characters, '-' (hyphen), '_' (underscore) and '.' (dot) only. The first and the last character can't be '-' (hyphen). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCARack 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> <dev:code> # # The following example modifies the name, location, and room for a rack with UUID AAAAAAAAAAAA. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Set-LXCARack -RackUuid AAAAAAAAAAAA -Name NewMyRack -Location Lab-2 -Room 201 Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Set-LXCARackItem --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCARackItem</command:name> <maml:description> <maml:para>This cmdlet modifies properties for a managed device in a rack.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCARackItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet modifies properties for a managed device in a rack. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCARackItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device to be displayed in the rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemType</maml:name> <maml:description> <maml:para> Specifies the managed-device type. This can be one of the following values: - Chassis - Server - Switch - Storage - Placeholder (filler) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCARackItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexSystemId</maml:name> <maml:description> <maml:para>Specifies the ID of the scalable complex system when the target item is a scalable-complex system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of the managed device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComplexSystemId</maml:name> <maml:description> <maml:para>Specifies the ID of the scalable complex system when the target item is a scalable-complex system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Specifies the name of the managed device to be displayed in the rack</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemLowestRackUnit</maml:name> <maml:description> <maml:para>Specifies the lowest rack unit position of the managed device in the target rack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ItemType</maml:name> <maml:description> <maml:para> Specifies the managed-device type. This can be one of the following values: - Chassis - Server - Switch - Storage - Placeholder (filler) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCARackItem 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> <dev:code> # # The following example modifies the lowest rack unit value of server with UUID BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB. $cred = Get-Credential Connect-LXCA -Host 192.0.2.0 -Credential $cred Set-LXCARackItem -RackUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -ItemUuid BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB` -ItemLowestRackUnit 10 -ItemType Server Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Set-LXCAResourceAccessControl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCAResourceAccessControl</command:name> <maml:description> <maml:para>This cmdlet enables or disables the global resource access control.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCAResourceAccessControl</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet enables or disables the global resource access control.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCAResourceAccessControl</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Enabled</maml:name> <maml:description> <maml:para>True to enable the Resource Access Control and false to disable it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Enabled</maml:name> <maml:description> <maml:para>True to enable the Resource Access Control and false to disable it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns result message.</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> <dev:code> Set-LXCAResourceAccessControl -Enabled $true </dev:code> <dev:remarks> <maml:para>This command enables Resource Access Control.</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:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Set-LXCAResourceView --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCAResourceView</command:name> <maml:description> <maml:para>This cmdlet modifies the resource access-control settings of an endpoint. Only users with lxc-supervisor or lxc-security-admin privileges can modify the access-control settings.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCAResourceView</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet modifies the resource access-control settings of an endpoint. Only users with lxc-supervisor or lxc-security-admin privileges can modify the access-control settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCAResourceView</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupNames</maml:name> <maml:description> <maml:para>Specifies the role group names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the node resource Uuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PublicAccess</maml:name> <maml:description> <maml:para>Specifies the public access setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Chassis</maml:name> <maml:description> <maml:para>Specifies that managed endpoint item is a chassis.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCAResourceView</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupNames</maml:name> <maml:description> <maml:para>Specifies the role group names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the node resource Uuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PublicAccess</maml:name> <maml:description> <maml:para>Specifies the public access setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies that managed endpoint item is a System x or ThinkServer server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCAResourceView</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupNames</maml:name> <maml:description> <maml:para>Specifies the role group names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the node resource Uuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PublicAccess</maml:name> <maml:description> <maml:para>Specifies the public access setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Switch</maml:name> <maml:description> <maml:para>Specifies that managed endpoint item is a switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCAResourceView</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupNames</maml:name> <maml:description> <maml:para>Specifies the role group names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the node resource Uuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PublicAccess</maml:name> <maml:description> <maml:para>Specifies the public access setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bool</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies that managed endpoint item is a storage node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PublicAccess</maml:name> <maml:description> <maml:para>Specifies the public access setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Specifies the Uuid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupNames</maml:name> <maml:description> <maml:para>Specifies the role group names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Chassis</maml:name> <maml:description> <maml:para>Specifies that managed endpoint item is a chassis.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies that the managed endpoint is a System x or ThinkServer server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Switch</maml:name> <maml:description> <maml:para>Specifies that the managed endpoint is a top-of-rack switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies that the managed endpoint is a storage node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>Set-LXCAResourceView 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> <dev:code> Set-LXCAResourceView -RoleGroupNames $roleGroupName1,$roleGroupName2 -Uuid $uuid -PublicAccess $true -server </dev:code> <dev:remarks> <maml:para>This command modifies the access-control settings of the endpoint.</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:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Set-LXCARoleGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCARoleGroup</command:name> <maml:description> <maml:para>This cmdlet modifies a specific role group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCARoleGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet modifies a specific role group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCARoleGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of role group. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupName</maml:name> <maml:description> <maml:para>Specifies the name of group. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleList</maml:name> <maml:description> <maml:para>Specifies the role list of group. The RoleList must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserList</maml:name> <maml:description> <maml:para>Specifies the user list of the role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of group. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroupName</maml:name> <maml:description> <maml:para>Specifies the name of group. The name must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleList</maml:name> <maml:description> <maml:para>Specifies the role list of group. The RoleList must be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserList</maml:name> <maml:description> <maml:para>Specifies the user list of the role group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns result message.</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> <dev:code> $group = Get-LXCARoleGroup -GroupName TEST $role = Get-LXCARole $user = Get-LXCAUserAccount -GetUserName update rolegroup name: Set-LXCARoleGroup -Id $group.Id -RoleGroupName $name update rolegroup Description :Set-LXCARoleGroup -Id $group.Id -Description $desc update rolegroup RoleList :Set-LXCARoleGroup -Id $group.Id -RoleList $role[1],$role[2] update rolegroup UserList :Set-LXCARoleGroup -Id $group.Id -UserList $user[1],$user[2] </dev:code> <dev:remarks> <maml:para>This command creates a new role group instance.</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-LXCARole</maml:linkText> <maml:linkText>Get-LXCAUserAccount</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Set-LXCAStoredCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCAStoredCredential</command:name> <maml:description> <maml:para> Modifies properties for a specific stored credential. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCAStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet modifies properties for a specific stored credential in the Lenovo XClarity Administrator server. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCAStoredCredential</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para> Specifies the ID of a specific stored credential to be modified. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para> Specifies the new user ID of the stored credential. Note: - You cannot change a user name if the stored credential is associated with one or more devices. Any attempt to change the user name for a stored credential that is currently in use will throw an exception Internal Server Error. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para> Specifies the new password of the stored credential. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para> Specifies the new description of the stored credential. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para> Specifies the ID of a specific stored credential to be modified. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para> Specifies the new user ID of the stored credential. Note: - You cannot change a user name if the stored credential is associated with one or more devices. Any attempt to change the user name for a stored credential that is currently in use will throw an exception Internal Server Error. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para> Specifies the new password of the stored credential. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para> Specifies the new description of the stored credential. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet 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> <dev:code> # # The following example modifies the user name, password and description for a specific stored credential. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $description = "Update user and password" $pwd = ConvertTo-SecureString "password" -AsPlainText -Force Set-LXCAStoredCredential -Id $id -Password $pwd -UserName "ADMIN" -Description $description Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example modifies the password and description for a specific stored credential. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $description = "Password updated on 02.28.2020" $pwd = ConvertTo-SecureString "password" -AsPlainText -Force Set-LXCAStoredCredential -Id $id -Password $pwd -Description $description Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Set-LXCASwitchPort --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCASwitchPort</command:name> <maml:description> <maml:para> Enable or disable specific ports on a managed RackSwitch or Flex System switch using the Lenovo XClarity Administrator server. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCASwitchPort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> Thhis cmdlet enables or disables the port setting on the managed RackSwitch or Flex System switches via the Lenovo XClarity Administrator server. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCASwitchPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch that containst the ports to be changed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Action</maml:name> <maml:description> <maml:para> Indicates whether to enable or disable the specified ports. You can specify one of the following values: - Enable - Disable </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para> Specifies the name of one or more ports to be set. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Uuid</maml:name> <maml:description> <maml:para> Specifies the UUID of the switch that containst the ports to be changed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Action</maml:name> <maml:description> <maml:para> Indicates whether to enable or disable the specified ports. You can specify one of the following values: - Enable - Disable </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para> Specifies the name of one or more ports to be set. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns the operation result.</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> <dev:code> # # The following example disables specific ports in a managed switch. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck Set-LXCASwitchPort –Action Disable –Port "Ethernet1","Ethernet1" –Uuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example enables all ports in a managed switch. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $rackSwitch = Get-LXCARackSwitch –Uuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA $portList=@(); foreach($i in $rackswitch.Ports) { $portList += $i.Port } Set-LXCASwitchPort –Action Enable –Port $portList –Uuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Set-LXCASystemIPInterface --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCASystemIPInterface</command:name> <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> <command:verb>Set</command:verb> <command:noun>LXCASystemIPInterface</command:noun> <dev:version /> </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> <maml:name>Set-LXCASystemIPInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CMMUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>InterfaceName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4DHCPmode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Subnet</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Gateway</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Address</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6DHCPenabled</maml:name> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StatelessEnabled</maml:name> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StaticEnabled</maml:name> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Gateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Prefix</maml:name> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Address</maml:name> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemIPInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>InterfaceName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4DHCPmode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Subnet</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Gateway</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Address</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6DHCPenabled</maml:name> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StatelessEnabled</maml:name> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StaticEnabled</maml:name> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Gateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Prefix</maml:name> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Address</maml:name> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemIPInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>InterfaceName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4DHCPmode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Subnet</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Gateway</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Address</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6DHCPenabled</maml:name> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StatelessEnabled</maml:name> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StaticEnabled</maml:name> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Gateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Prefix</maml:name> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Address</maml:name> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemIPInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Flex switch for which you want to set the IP interface.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>InterfaceName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4DHCPmode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Subnet</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Gateway</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Address</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6DHCPenabled</maml:name> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StatelessEnabled</maml:name> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StaticEnabled</maml:name> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Gateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Prefix</maml:name> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Address</maml:name> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CMMUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Flex switch for which you want to set IP interface.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>InterfaceName</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4DHCPmode</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Subnet</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Gateway</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv4Address</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6DHCPenabled</maml:name> <maml:description> <maml:para>Specifies to use stateful address configuration (DHCPv6).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StatelessEnabled</maml:name> <maml:description> <maml:para>Specifies to use stateless address auto-configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>IPv6StaticEnabled</maml:name> <maml:description> <maml:para>Specifies to use a statically assigned IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Gateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 gateway address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Prefix</maml:name> <maml:description> <maml:para>Specifies the IPv6 prefix length to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StaticIPv6Address</maml:name> <maml:description> <maml:para>Specifies the IPv6 address to be used when IPv6StaticEnabled is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <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> <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> <!-- Set-LXCASystemProperty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCASystemProperty</command:name> <maml:description> <maml:para> Modifies the properties for a chassis, rack or tower server, RackSwitch switch, or rack storage device. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCASystemProperty</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Set-LXCASystemProperty cmdlet modifies the properties for a chassis, rack or tower server, RackSwitch switch, or rack storage device. You can set properties such as hostname, description, contact, and display name. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-LXCASystemProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a chassis for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the device location value to be set. The location can be 1 - 47 characters. You can use upper and lower case letter, number, and the following special characters: dash (-), underscore (_), and period (.). The first and last character cannot be a dash. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EncapsulationMode</maml:name> <maml:description> <maml:para> Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specifies the host name to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the device location value to be set. The location can be 1 - 47 characters. You can use upper and lower case letter, number, and the following special characters: dash (-), underscore (_), and period (.). The first and last character cannot be a dash. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EncapsulationMode</maml:name> <maml:description> <maml:para> Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a System x server for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the device location value to be set. The location can be 1 - 47 characters. You can use upper and lower case letter, number, and the following special characters: dash (-), underscore (_), and period (.). The first and last character cannot be a dash. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EncapsulationMode</maml:name> <maml:description> <maml:para> Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a think server for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the device location value to be set. The location can be 1 - 47 characters. You can use upper and lower case letter, number, and the following special characters: dash (-), underscore (_), and period (.). The first and last character cannot be a dash. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a RackSwitch switch for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the device location value to be set. The location can be 1 - 47 characters. You can use upper and lower case letter, number, and the following special characters: dash (-), underscore (_), and period (.). The first and last character cannot be a dash. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCASystemProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Lenovo storage for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ChassisUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a chassis for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ComputeNodeUuid</maml:name> <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> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a System x server for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ThinkServerUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a ThinkServer server for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RackSwitchUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a RackSwitch switch for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageUuid</maml:name> <maml:description> <maml:para>Specifies the UUID of a Lenovo storage for which you want to set the properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specifies the host name value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>Specifies the contact value to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para> Specifies the device location value to be set. The location can be 1 - 47 characters. You can use upper and lower case letter, number, and the following special characters: dash (-), underscore (_), and period (.). The first and last character cannot be a dash. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EncapsulationMode</maml:name> <maml:description> <maml:para> Specifies the encapsulation value to be set. -normal. -encapsulationLite. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <dev:code> Set-LXCASystemProperty -ChassisUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -DisplayName "Display Name" -Contact "Admin" </dev:code> <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> <!-- Set-LXCAUserAccount --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCAUserAccount</command:name> <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> <command:verb>Set</command:verb> <command:noun>LXCAUserAccount</command:noun> <dev:version /> </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> <maml:name>Set-LXCAUserAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserAccount</maml:name> <maml:description> <maml:para>Specifies the user account to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroups</maml:name> <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_RECOVERY. 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. These users can also authenticate directly to the Lenovo XClarity Administrator even if the authentication method is set to external LDAP server. This role provides a recovery mechanism in case a communication error occurs with the external LDAP server that uses the "Login Credentials" configuration. 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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the user account. Values can be Active or Inactive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description to be used for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserAccount</maml:name> <maml:description> <maml:para>Specifies the user account to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserAccount</command:parameterValue> <dev:type> <maml:name>UserAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RoleGroups</maml:name> <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_RECOVERY. 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. These users can also authenticate directly to the Lenovo XClarity Administrator even if the authentication method is set to external LDAP server. This role provides a recovery mechanism in case a communication error occurs with the external LDAP server that uses the "Login Credentials" configuration. 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> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the user account. Values can be Active or Inactive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description to be used for the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.UserAccount</maml:name> <maml:uri/> <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> <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> <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> <!-- Set-LXCAUserAccountPassword --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-LXCAUserAccountPassword</command:name> <maml:description> <maml:para>Modifies the password for an existing user account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCAUserAccountPassword</command:noun> <dev:version /> </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> <maml:name>Set-LXCAUserAccountPassword</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentPassword</maml:name> <maml:description> <maml:para>Specifies the current password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>Specifies the new password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConfirmPassword</maml:name> <maml:description> <maml:para>Confirms the new password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-LXCAUserAccountPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Host</maml:name> <maml:description> <maml:para>Specifies the Lenovo XClarity Administrator server HTTPS address (IP address or host name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Proxy</maml:name> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user ID of the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentPassword</maml:name> <maml:description> <maml:para>Specifies the current password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>Specifies the new password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConfirmPassword</maml:name> <maml:description> <maml:para>Confirm the new password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Host</maml:name> <maml:description> <maml:para>Specifies the HTTPS address (IP address or host name) of the Lenovo XClarity Administrator server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the Lenovo XClarity Administrator server to be used for the connection.</maml:para> </maml:description> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="NoOverwrite"> <maml:name>Proxy</maml:name> <maml:description> <maml:para>Specifies a Web service proxy object that includes proxy connection and authentication information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebProxy</command:parameterValue> <dev:type> <maml:name>WebProxy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user ID of the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentPassword</maml:name> <maml:description> <maml:para>Specifies the current password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>Specifies the new password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConfirmPassword</maml:name> <maml:description> <maml:para>Confirm the new password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>None</maml:name> <maml:uri/> <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> <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> <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> <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> <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> <!-- Start-LXCAEventMonitor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-LXCAEventMonitor</command:name> <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> <command:verb>Start</command:verb> <command:noun>LXCAEventMonitor</command:noun> <dev:version /> </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> <maml:name>Start-LXCAEventMonitor</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventID</maml:name> <maml:description> <maml:para>Specifies the event IDs that will be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUIDs of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MessageRegex</maml:name> <maml:description> <maml:para>Specifies the event message regex expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">LXCAConnection</command:parameterValue> <dev:type> <maml:name>LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventID</maml:name> <maml:description> <maml:para>Specifies the event IDs that will be monitored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specifies the UUID of the component that is/was the event source (raiser/owner).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Severity</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventSeverity[]</command:parameterValue> <dev:type> <maml:name>EventSeverity[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>EventClass</maml:name> <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> <command:parameterValue required="true" variableLength="false">EventClass[]</command:parameterValue> <dev:type> <maml:name>EventClass[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MessageRegex</maml:name> <maml:description> <maml:para>Specifies the event message regex expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> <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> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAEventMonitor</maml:name> <maml:uri/> <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> <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> <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> <!-- Stop-LXCATask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-LXCATask</command:name> <maml:description> <maml:para>Cancels one or more tasks (jobs) on the Lenovo XClarity Administrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>LXCATask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet cancels one or more running or pending tasks (jobs) on the Lenovo XClarity Administrator server. Not all tasks can be stopped. This cmdlet stop only tasks for which the isStoppable attribute is set to true. The task ID is returned for only the tasks that were stopped. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-LXCATask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskId"> <maml:name>TaskUIDs</maml:name> <maml:description> <maml:para> Specifies one or more task IDs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -JobID -TaskId -TaskUID </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-LXCAJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Job"> <maml:name>Tasks</maml:name> <maml:description> <maml:para> Specifies one or more task instances. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -Job -Task </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="TaskId"> <maml:name>TaskUIDs</maml:name> <maml:description> <maml:para> Specifies one or more task IDs. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -JobID -TaskId -TaskUID </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Job"> <maml:name>Tasks</maml:name> <maml:description> <maml:para> Specifies one or more task instances. Note: The following aliases are accepted for this parameter name for backward compatibility. These aliases will be deprecated in a future release. -Job -Task </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LxcaJob[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet stops one or more tasks from the XClarity Administrator server and returns the task UIDs of the stopped jobs as an array of strings. If none of the specified tasks can be stopped, the returned object is an empty array. </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> <dev:code> # # The following example cancels all running and pending tasks from the XClarity Administrator server. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $tasks = Get-LXCATask -State Running,Pending Stop-LXCATask -Task $tasks Disconnect-LXCA </dev:code> <dev:remarks> <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> <!-- Update-LXCAFirmwareRepository --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-LXCAFirmwareRepository</command:name> <maml:description> <maml:para> Modify information about firmware updates and UpdateXpress System Packs (UXSPs) in the firmware-updates repository. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>LXCAFirmwareRepository</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> This cmdlet refreshes the firmware catalog by retrieving information (metadata) about firmware updates and UpdateXpress System Packs (UXSPs) from the Lenovo Support website, or downloads specific firmware updates or UXSPs from Lenovo XClarity Support website and stores the files in the updates repository. Note: - You cannot pipe objects to this cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-LXCAFirmwareRepository</maml:name> <command:description> Refresh catalog information about all firmware updates or UXSPs from the Lenovo XClarity Support website. The information is stored the information to the updates repository. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RefreshCatalog</maml:name> <maml:description> <maml:para> Specifies the download of the firmware catalog. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UXSPs</maml:name> <maml:description> <maml:para> When specified, retrieves information about UXSPs from the Lenovo XClarity Support website. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LatestOnly</maml:name> <maml:description> <maml:para> When specified, returns information about the most current version of all firmware updates. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para> When specified, the cmdlet runs as background job and returns a Job object immediately. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-LXCAFirmwareRepository</maml:name> <command:description> Refresh catalog information about all firmware updates or UXSPs from the Lenovo XClarity Support website for specified machines only. The information is stored the information to the updates repository. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RefreshCatalog</maml:name> <maml:description> <maml:para> Specifies the download of the firmware catalog. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MachineTypes</maml:name> <maml:description> <maml:para> Specify the machine types for which the catalog of the firmware updates or UXSPs will be retrieved from the Lenovo XClarity Support website. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UXSPs</maml:name> <maml:description> <maml:para> When specified, retrieves information about UXSPs from the Lenovo XClarity Support website. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LatestOnly</maml:name> <maml:description> <maml:para> When specified, returns information about the most current version of all firmware updates. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para> When specified, the cmdlet runs as background job and returns a Job object immediately. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-LXCAFirmwareRepository</maml:name> <command:description> Downloads the specified firmware updates from Lenovo XClarity Support website, and stores the updates to the updates repository. </command:description> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AcquirePackages</maml:name> <maml:description> <maml:para> Downloads the specified firmware updates. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PackagesIDs</maml:name> <maml:description> <maml:para> Specify the fixids of the firmware packages which will be downloaded from the Lenovo XClarity Support website. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para> When specified, the cmdlet runs as background job and returns a Job object immediately. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Connection</maml:name> <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> <command:parameterValue required="true" variableLength="false">Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</command:parameterValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>The result from the last Connect-LXCA cmdlet</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>RefreshCatalog</maml:name> <maml:description> <maml:para> Specifies the download of the firmware catalog. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AcquirePackages</maml:name> <maml:description> <maml:para> Downloads the specified firmware updates. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>UXSPs</maml:name> <maml:description> <maml:para> When specified, retrieves information about UXSPs from the Lenovo XClarity Support website. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>LatestOnly</maml:name> <maml:description> <maml:para> When specified, returns information about the most current version of all firmware updates. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true" position="named" aliases=""> <maml:name>AsJob</maml:name> <maml:description> <maml:para> When specified, the cmdlet runs as background job and returns a Job object immediately. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>WaitForJob</maml:name> <maml:description> <maml:para> When specified with the –AsJob parameter, PowerShell waits for this background job in XClarity Administrator to either start or complete before running the next cmdlet in the script. This can be one of the following values: - ToStart PowerShell waits until this background job starts in XClarity Administrator, so multiple jobs can run synchronously. - ToEnd PowerShell waits until this background job completes in XClarity Administrator, so that one only job runs at a time. Note: - If this parameter not specified, this cmdlet does not wait. The next cmdlet in the script runs regardless of whether this background job starts or completes. - If -AsJob is not specified, this parameter is ignored. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>MachineTypes</maml:name> <maml:description> <maml:para> Specify the machine types for which the catalog of the firmware updates or UXSPs will be retrieved from the Lenovo XClarity Support website. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PackagesIDs</maml:name> <maml:description> <maml:para> Specify the fixids of the firmware packages which will be downloaded from the Lenovo XClarity Support website. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.LXCAConnection</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.Job</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> If you specify the -AsJob parameter, this cmdlets returns a System.Management.Automation.Job object. </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.SysMgmt.LXCA.Integration.Data.FirmwareRepositoryData</maml:name> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> This cmdlet returns a Lenovo.SysMgmt.LXCA.Integration.Data.FirmwareRepositoryData object which contains information about the firmware repository. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para> - You cannot pipe objects to this cmdlet. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code> # # The following example downloads specified firmware packages. The cmdlet is run as a PowerShell job. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $packs = @( "lnvgy_fw_sraidmr35_930-50.0.1-0374-1_linux_x86-64", "lnvgy_fw_xcc_cdi346l-3.60_anyos_noarch", "lnvgy_utl_uxsp_c6sp03p-1.40_platform_32-64" ) $result = Update-LXCAFirmwareRepository -AcquirePackages -PackagesIDs $packs -AsJob -WaitForJob ToEnd # show job information. $job|Format-List # show general information about the downloaded packages contained in job object. $job.Output|Format-List # show the number of firmware packages included which were downloaded. $job.Output.FirmwarePackages.Count # show the details of one firmware package. $job.Output.FirmwarePackages[0] #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example retrieves the firmware catalog for all firmwares. The cmdlet is run as a PowerShell job. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $job = Update-LXCAFirmwareRepository -RefreshCatalog -AsJob -WaitForJob ToEnd # show job information. $job|Format-List # show general information about the firmware catalog contained in job object. $job.Output|Format-List # show the number of firmware packages included in this catalog. $job.Output.FirmwarePackages.Count # show the details of one firmware package. $job.Output.FirmwarePackages[20] #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> <dev:code> # # The following example retrieves the firmware catalog for latest UXSPs packages. $cred = Get-Credential Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck $result = Update-LXCAFirmwareRepository -RefreshCatalog -UXSPs -LatestOnly # show general information about the UXSPs catalog. $result|Format-List # show the number of firmware packages included in this catalog. $result.FirmwarePackages.Count # show the details of one firmware package. $result.FirmwarePackages[20] #Disconnect from LXCA Disconnect-LXCA </dev:code> <dev:remarks> <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> </helpItems> |