en-US/Lenovo.XClarityOrchestrator.PowerShell.Automation.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?><helpItems schema="maml">
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-LXCOPSLogHeader</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>LXCOPSLogHeader</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet writes a user message as a header in the PS log file, which can be used to mark the start and end of a block in a script.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCOPSLogHeader</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified, adds the user identity (user name and domain if is the case) in the header that is to be written in PS log file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MachineId</maml:name> <maml:description> <maml:para>If specified, adds the machine identity (machine name) in the header that is to be written in PS log file.</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"> <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">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified, adds the user identity (user name and domain if is the case) in the header that is to be written in PS log file.</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>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MachineId</maml:name> <maml:description> <maml:para>If specified, adds the machine identity (machine name) in the header that is to be written in PS log file.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet does not return any data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example writes a full message header in PS log file. # -UserMessage contains the full name of the current script. Add-LXCOPSLogHeader -Identity -MachineId -UserMessage "Starting '$PSCommandPath'"</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-LXCOPSLogLevel</command:name> <maml:description> <maml:para>Sets the log level of the PowerShell cmdlets for the Lenovo XClarity Orchestrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>LXCOPSLogLevel</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet modifies 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-LXCOPSLogLevel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Specifies the type of errors that are added to the log. You can specify one of the following log levels: - Error. Messages with a severity of Error are added to the log. - Warn. Messages with a severity of Error and Warning are added to the log. - Info. Messages with a severity of Error, Warning, and Info are added to the log. This is the default level. - Debug. Messages of all severities and additional information that is required to debug issues are added to the log.</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"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Specifies the type of errors that are added to the log. You can specify one of the following log levels: - Error. Messages with a severity of Error are added to the log. - Warn. Messages with a severity of Error and Warning are added to the log. - Info. Messages with a severity of Error, Warning, and Info are added to the log. This is the default level. - Debug. Messages of all severities and additional information that is required to debug issues are added to the log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet modifies the level of errors that are added to the PowerShell log. No objects are returned.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example adds messages of all severities and additional debug information to the log. Set-LXCOPSLogLevel -LogLevel Debug</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Connect-LXCO</command:name> <maml:description> <maml:para>Connects to the Lenovo xClarity Orchestrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>LXCO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet creates a connection to the Lenovo xClarity Orchestrator server that can be used by other cmdlets. Use the Disconnect-LXCO cmdlet to disconnect from xClarity Orchestrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-LXCO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostUri</maml:name> <maml:description> <maml:para>Specifies the HTTPS address (IP address or hostname) for the XClarity Orchestrator 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"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a credential object that includes the credentials for logging in to the XClarity Orchestrator 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"> <maml:name>SkipCertificateCheck</maml:name> <maml:description> <maml:para>If specified, this cmdlet does not check for server certificates. Otherwise, the connection is made only if the XClarity Orchestrator server contains a valid certificate that is signed by a trusted certification authority.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the XClarity Orchestrator server to be used for the connection. The default value is 443.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds that the cmdlet waits for an HTTPS response from the XClarity Orchestrator server. By default, the time-out value is 600 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyUri</maml:name> <maml:description> <maml:para>Specifies the IP address or hostname of a network proxy server of the proxy server to use instead of connecting directly to the internet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>Specifies a credential object for a user account that has permission to use the proxy server that is specified by the Proxy parameter. This parameter is valid only when the -ProxyUri parameter is specified. You cannot use the -ProxyCredential and -ProxyUseDefaultCredentials parameters in the same command.</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"> <maml:name>ProxyUseDefaultCredentials</maml:name> <maml:description> <maml:para>Indicates that the cmdlet uses the credentials of the current user to access the proxy server that is specified by the -ProxyUri parameter. This parameter is valid only when the -ProxyUri parameter is specified. You cannot use the -ProxyCredential and -ProxyUseDefaultCredentials parameters in the same command.</maml:para> </maml:description> <command:parameterValue required="false" 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"> <maml:name>HostUri</maml:name> <maml:description> <maml:para>Specifies the HTTPS address (IP address or hostname) for the XClarity Orchestrator 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a credential object that includes the credentials for logging in to the XClarity Orchestrator 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipCertificateCheck</maml:name> <maml:description> <maml:para>If specified, this cmdlet does not check for server certificates. Otherwise, the connection is made only if the XClarity Orchestrator server contains a valid certificate that is signed by a trusted certification authority.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the XClarity Orchestrator server to be used for the connection. The default value is 443.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds that the cmdlet waits for an HTTPS response from the XClarity Orchestrator server. By default, the time-out value is 600 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyUri</maml:name> <maml:description> <maml:para>Specifies the IP address or hostname of a network proxy server of the proxy server to use instead of connecting directly to the internet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>Specifies a credential object for a user account that has permission to use the proxy server that is specified by the Proxy parameter. This parameter is valid only when the -ProxyUri parameter is specified. You cannot use the -ProxyCredential and -ProxyUseDefaultCredentials parameters in the same command.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyUseDefaultCredentials</maml:name> <maml:description> <maml:para>Indicates that the cmdlet uses the credentials of the current user to access the proxy server that is specified by the -ProxyUri parameter. This parameter is valid only when the -ProxyUri parameter is specified. You cannot use the -ProxyCredential and -ProxyUseDefaultCredentials parameters in the same command.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name> System.Management.Automation.PSCredential</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If a connections was successfully created, this cmdlet returns an LXCOConnection object that contains information about the xClarity Orchestrator server connection.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If a connection can not be created, this cmdlet returns an RequestStatusMessage object that contains information about the xClarity Orchestrator server connection failure. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential $connection = Connect-LXCO -HostUri 192.0.2.0 -Credential $cred</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Disconnect-LXCO</command:name> <maml:description> <maml:para>Disconnects from Lenovo XClarity Orchestrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>LXCO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disconnect-LXCO cmdlet deletes the connection to an Lenovo xClarity Orchestrator server. A connection is not deleted if it have running background jobs attached, unless the -Force parameter is specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-LXCO</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Delete the connection to the XClarity Orchestrator server even there are running PowerShell background jobs assigned to this connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Disconnect-LXCO</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Delete the connection to the XClarity Orchestrator server even there are running PowerShell background jobs assigned to this connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Delete all connections which exists in current PowerShell session.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Delete the connection to the XClarity Orchestrator server even there are running PowerShell background jobs assigned to this connection.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Delete all connections which exists in current PowerShell session.</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>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>Contains information about the connection to be deleted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the cmdlet execution succeeds, a LXCOConnection object which contains information about the connection which was deleted.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If there was an error, then this cmdlet returns a RequestStatusMessage object which contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>Delete the default connection</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Disconnect-LXCO -Connection $connection -Force</dev:code> <dev:remarks> <maml:para>Delete a spefied connection, even there are running background jobs assigned to it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Disconnect-LXCO -All -Force</dev:code> <dev:remarks> <maml:para>Delete all connections in current PowerShell session, even there are running background jobs assigned to these connections..</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Invoke-LXCORestMethod</command:name> <maml:description> <maml:para>Invokes a Lenovo xClarity Orchestrator REST API.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>LXCORestMethod</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet invokes a Lenovo xClarity Orchestrator REST API directly.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-LXCORestMethod</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo xClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the HTTP request method. You can specify one of the following methods: - DELETE - GET - PATCH - POST - PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebRequestMethod</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Specifies the output directory and file name in which to return the request's response. - If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name (lxcoRestMethod_MMddyyyy-HHmmss.out) is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestBody</maml:name> <maml:description> <maml:para>Specifies the request body.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCORestMethod</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo xClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the HTTP request method. You can specify one of the following methods: - DELETE - GET - PATCH - POST - PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebRequestMethod</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Specifies the output directory and file name in which to return the request's response. - If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name (lxcoRestMethod_MMddyyyy-HHmmss.out) is used. - If the directory does not exist, it is automatically created.</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"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Specifies the file 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"> <maml:name>InFileFormName</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:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection to the Lenovo xClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the HTTP request method. You can specify one of the following methods: - DELETE - GET - PATCH - POST - PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebRequestMethod</command:parameterValue> <dev:type> <maml:name>WebRequestMethod</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Specifies the output directory and file name in which to return the request's response. - If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name (lxcoRestMethod_MMddyyyy-HHmmss.out) is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestBody</maml:name> <maml:description> <maml:para>Specifies the request body.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Specifies the file 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InFileFormName</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.WebRequestMethod</maml:name> <maml:uri /> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCORestResponse</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet returns an LXCORestResponse object that contains information about the executed REST API (resource uri, HTTP status code, response body, ..).</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $requestBody = @{ managers = @( @{ authentication = @{ password = "CME44len" type = "basic" username = "USERID" } connection = @{ hostname = "192.0.2.44" port = 443 } options = @{ enableDriveAnalyticsData = $true } type = "XClarity Administrator" } ) } | ConvertTo-Json -Depth 4 -Compress $url = "/api/v1/connector/managers" $postResult = Invoke-LXCORestMethod -Method Post -ResourceUrl $url -RequestBody $requestBody -OutFile $PSScriptRoot/../test/ $postResult | Format-List $obj = ConvertFrom-Json -InputObject $postResult.ResponseBody $obj | Format-List Disconnect-LXCO </dev:code> <dev:remarks> <maml:para>The following example add a resource manager by sending the POST /api/v1/connector/managers request.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceUri : /api/v1/connector/managers ResponseStatusCode : Created ResponseBody : {"text":"The request was launched successfully.","description":"The request to connect managers was launched successfully.","userAction":"Information only; refresh your information.","recoveryURL":null,"code":"FQXXOCO1006I","status":"Informational"} LocationHeaderValue : /api/v1/jobs-engine/jobs/57 RequestTimeStamp : 6/17/2021 7:54:07 PM OutFile : C:\Users\psuser\PowerShell\scripts\test\lxcoRestMethod_06172021-195407.out text : The request was launched successfully. description : The request to connect managers was launched successfully. userAction : Information only; refresh your information. recoveryURL : code : FQXXOCO1006I status : Informational </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $url = "/api/v1/maintenance/selfUpdates" $inFile = "F:\LXCORepository\update-LXCO-135.tar.gz" $postResult = Invoke-LXCORestMethod -Method Post -ResourceUrl $url -InFile $inFile -InFileFormName updatePackage -OutFile $PSScriptRoot/../test2/ $postResult | Format-List $obj = ConvertFrom-Json -InputObject $postResult.ResponseBody $obj.jobId Disconnect-LXCO </dev:code> <dev:remarks> <maml:para>The following example uploads an Orchestrator Server update package file.</maml:para> <maml:para /> <maml:para /> <maml:para> ResourceUri : /api/v1/maintenance/selfUpdates ResponseStatusCode : OK ResponseBody : {"jobId":"1624012667875c6ug4z9u"} LocationHeaderValue : RequestTimeStamp : 6/18/2021 1:37:47 PM OutFile : C:\Users\ecelmare\OneDrive - Lenovo\Documents\PowerShell\scripts\LXCO_Scripts\test2\lxcoRestMethod_06182021-133747.out C:\Users\psuser\PowerShell\scripts 1624012667875c6ug4z9u </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-LXCOManager</command:name> <maml:description> <maml:para>Connect a resource manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>LXCOManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to connect (register) a resource manager to a xClarity Orchestrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-LXCOManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerType</maml:name> <maml:description> <maml:para>Type of resource manager.</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"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a credential object required to authenticate on to the manager.</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"> <maml:name>Port</maml:name> <maml:description> <maml:para>Resource manager port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerIP</maml:name> <maml:description> <maml:para> Resource manager 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"> <maml:name>EnableDriveAnalyticsData</maml:name> <maml:description> <maml:para>If specified, drive analytics data collection is enabled,. Note: This parameter is used only by the XClarity Administrator resource manager and is ignored for all other managers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthSource</maml:name> <maml:description> <maml:para>Name of the authentication source for users and groups. Note: This parameter is used only by the vRealize Operations Manager and is ignored for all other managers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-LXCOManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerType</maml:name> <maml:description> <maml:para>Type of resource manager.</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"> <maml:name>APIKey</maml:name> <maml:description> <maml:para>Public API key for authentication on the Schneider Electric EcoStruxure IT Expert.</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"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Name assigned to this resource manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EcoStruxurePortalUrl</maml:name> <maml:description> <maml:para>Custom URL to access EcoStruxure IT portal.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerType</maml:name> <maml:description> <maml:para>Type of resource manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a credential object required to authenticate on to the manager.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Resource manager port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerIP</maml:name> <maml:description> <maml:para> Resource manager 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableDriveAnalyticsData</maml:name> <maml:description> <maml:para>If specified, drive analytics data collection is enabled,. Note: This parameter is used only by the XClarity Administrator resource manager and is ignored for all other managers.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthSource</maml:name> <maml:description> <maml:para>Name of the authentication source for users and groups. Note: This parameter is used only by the vRealize Operations Manager and is ignored for all other managers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIKey</maml:name> <maml:description> <maml:para>Public API key for authentication on the Schneider Electric EcoStruxure IT Expert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Name assigned to this resource manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EcoStruxurePortalUrl</maml:name> <maml:description> <maml:para>Custom URL to access EcoStruxure IT portal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name> System.Management.Automation.PSCredential</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the resource manager register request was accepted by the xClarity Orchestrator server, a LXCOJob object that contains the status of the register request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns an RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $apiKey = "AK1/2sixskmmc06wj/1i6v3epcz5c25rc29jv1t00hce1pjahyobux63" $portalUrl = "https://api.ecostruxureit.com/rest/v1/organizations" $result = Add-LXCOResourceManager -APIKey $apiKey -ManagerType SchneiderEcoStruxureIT -ResourceName "My EcoStruxure" -EcoStruxurePortalUrl $portalUrl Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example, adds a Schneider Electric EcoStruxure IT Expert resource manager.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $managerIp = "192.0.2.123" $managerCred = Get-Credential $result = Add-LXCOResourceManager -Credential $managerCred -ManagerIP $managerIp -ManagerType XClarityAdministrator -EnableDriveAnalyticsData Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example, adds a XClarity Administrator resource manager.The following example, adds a XClarity Administrator resource manager.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOManagers</command:name> <maml:description> <maml:para>Returns information about the resource managers registered in xClarity Orchestrator.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOManagers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to return information about a specified resource manager a list of all resource managers registered in xClarity Administrator. When a list is retrieved, the content of the list can be filtered against Manager Type or / and Manager Health State.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOManagers</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HealthStatus</maml:name> <maml:description> <maml:para>Specifiues a list of health statuses for the managers. The list can contain one of the following values: -Normal -Non-Critical -Warning -Minor-Failure -Major-Failure -Non-Recoverable -Critical -Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerType</maml:name> <maml:description> <maml:para>Specifies the type of resource managers to return. This can be one or more of the following values, separated by a comma: - Schneider EcoStruxure IT - Morpheus Data - vRealize Operations Manager - XClarity Administrator - XClarity Orchestrator</maml:para> <maml:para>Tip: If you specify a portion of a value, the toolkit finds the best match. For example, specify xclarity to return information for XClarity Orchestrator and all XClarity Administrator resource managers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectedInterval</maml:name> <maml:description> <maml:para>Specifies when the manager was connected as dates range, using the following format: <startDate>,<endDate>. The end date is optional. If not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOManagers</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerID</maml:name> <maml:description> <maml:para>Specifies the ID of the manager to retrieve.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HealthStatus</maml:name> <maml:description> <maml:para>Specifiues a list of health statuses for the managers. The list can contain one of the following values: -Normal -Non-Critical -Warning -Minor-Failure -Major-Failure -Non-Recoverable -Critical -Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerType</maml:name> <maml:description> <maml:para>Specifies the type of resource managers to return. This can be one or more of the following values, separated by a comma: - Schneider EcoStruxure IT - Morpheus Data - vRealize Operations Manager - XClarity Administrator - XClarity Orchestrator</maml:para> <maml:para>Tip: If you specify a portion of a value, the toolkit finds the best match. For example, specify xclarity to return information for XClarity Orchestrator and all XClarity Administrator resource managers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerID</maml:name> <maml:description> <maml:para>Specifies the ID of the manager to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectedInterval</maml:name> <maml:description> <maml:para>Specifies when the manager was connected as dates range, using the following format: <startDate>,<endDate>. The end date is optional. If not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Manager.ManagerFullData</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -ManagerId is specified, this cmdlet returns an ManagerFullData object that contains detailed information about the specified resource managers.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Manager.ManagerData[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -ManagerId is not specified, this cmdlet returns an array of ManagerlData objects, an object for each resource manager retrieved from xClarity Orchestrator.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns an RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOResourceManagers -ManagerID $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>Retrieve full data of the manager with the specified ID.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOResourceManagers $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>Retrieve the information for all registered resource managers.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOResourceManagers -ManagerType xclarity,morpheus -HealthStatus Critical,Normal $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>Retrieve the information for all registered resource managers of type xClarity and vRealize that are in Critical or Warning health state.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-LXCOManager</command:name> <maml:description> <maml:para>Disconnect (remove) a specific resource manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>LXCOManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to disconnect (remove) a specific resource manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LXCOManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerID</maml:name> <maml:description> <maml:para>Specified the id of the resource manager 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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagerID</maml:name> <maml:description> <maml:para>Specified the id of the resource manager 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the xClarity Orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the remove request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns an RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Remove-LXCOResourceManager -ManagerID D1331174CEB44EADB8AB80A502A0C35E Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example removes a specified resource manager.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCODevices</command:name> <maml:description> <maml:para>Retrieves details about one or more managed devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCODevices</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns a list of all managed devices or detailed information about a specific managed device. When a list is returned, the content of the list can be filtered.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCODevices</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCODevices</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCODevices</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of devices to return. This can be one of the following values: - Chassis - Server - Storage - Switch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the health states of devices to return. This can be one or more of the following values, separated by a comma: - Normal - Warning - Critical - Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connectivity</maml:name> <maml:description> <maml:para>Specifies the connectivity status of devices to return. This can be one or more of the following values, separated by a comma: - Online - Offline - OfflineManaged - Partial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Power</maml:name> <maml:description> <maml:para>Specifies the power status of devices to return. This can be one of the following values: - Off - On</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IpAddress</maml:name> <maml:description> <maml:para>Specifies the IP addresses, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies the groups names, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductName</maml:name> <maml:description> <maml:para>Specifies the product names, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TypeModel</maml:name> <maml:description> <maml:para>Specifies the machine-type models, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareName</maml:name> <maml:description> <maml:para>Specifies the firmware names, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareBuild</maml:name> <maml:description> <maml:para>Specifies the firmware builds, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareVersion</maml:name> <maml:description> <maml:para>Specifies the firmware versions, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WarrantyStatus</maml:name> <maml:description> <maml:para>Specifies the warranty status of devices to return. This can be one of the following values: - Active - Expired - RetrievingData - NoData</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareDate</maml:name> <maml:description> <maml:para>Specifies the firmware release dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of devices to return. This can be one of the following values: - Chassis - Server - Storage - Switch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the health states of devices to return. This can be one or more of the following values, separated by a comma: - Normal - Warning - Critical - Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connectivity</maml:name> <maml:description> <maml:para>Specifies the connectivity status of devices to return. This can be one or more of the following values, separated by a comma: - Online - Offline - OfflineManaged - Partial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Power</maml:name> <maml:description> <maml:para>Specifies the power status of devices to return. This can be one of the following values: - Off - On</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IpAddress</maml:name> <maml:description> <maml:para>Specifies the IP addresses, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies the groups names, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductName</maml:name> <maml:description> <maml:para>Specifies the product names, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TypeModel</maml:name> <maml:description> <maml:para>Specifies the machine-type models, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareName</maml:name> <maml:description> <maml:para>Specifies the firmware names, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareBuild</maml:name> <maml:description> <maml:para>Specifies the firmware builds, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareVersion</maml:name> <maml:description> <maml:para>Specifies the firmware versions, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WarrantyStatus</maml:name> <maml:description> <maml:para>Specifies the warranty status of devices to return. This can be one of the following values: - Active - Expired - RetrievingData - NoData</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareDate</maml:name> <maml:description> <maml:para>Specifies the firmware release dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.DeviceFullData</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -DevicerID is specified, this cmdlet returns an DeviceFullData object that contains detailed information about the specified devices.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.DeviceDataExtended</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -DeviceType is specified, this cmdlet returns an array of DeviceDataExtended objects, which contains more detailed information for each device of the specified type.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.DeviceData</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -DevicerID and -DeviceType are not specified, this cmdlet returns an array of DeviceData objects, which contains high-level information for each device.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCODevices -DeviceType Server ` -Status Critical,Normal,Warning ` -Connectivity Offline,Online ` -IpAddress 10.24 ` -Groups "not_available" ` -ProductName system ` -FirmwareName xcc,imm2 ` -FirmwareDate "5/20/2020" $result|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns list of all managed servers that meet specified criteria.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCODevices -DeviceID 00632D78DE644E23B712E200FE449787-7AF5D198CECF431AAEC674C7CA5A29B5 $result | Format-List Disconnect-LXCO </dev:code> <dev:remarks> <maml:para>The following example returns a detailed information about a specific device.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCODevices $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns a list of all managed devices, with high-level information about each device.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOFirmwareCatalog</command:name> <maml:description> <maml:para>Retrieves the update catalog.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOFirmwareCatalog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns a list of entries in the update catalog, or information about a specific entry in the updates catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOFirmwareCatalog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The ID of the entry in updates catalog.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The ID of the entry in updates catalog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.FirmwareCatalogEntry[]</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -ID is not specified, this cmdlet returns an array of FirmwareCatalogEntry objects, which contains information about the entries in the update catalog.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.DeviceFirmwareCatalog</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -ID is specified, this cmdlet returns a DeviceFirmwareCatalog object, with information about the specified entry in the updates catalog.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOFirmwareCatalog -ID "repopack" $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns a detailed information about a specified entry in updates catalog.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Update-LXCOFirmwareCatalog</command:name> <maml:description> <maml:para>Refresh the updates catalog or download specified packages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>LXCOFirmwareCatalog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to refresh the updates catalog by downloading information (metadata) about updates that are applicable to your managed resources or download specified packages from the Lenovo Support website.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-LXCOFirmwareCatalog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareAge</maml:name> <maml:description> <maml:para>When is specified, this parameter indicates which firmware to refresh: all or latest. If is not specified, latest firmware is refreshed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IDs</maml:name> <maml:description> <maml:para>List of IDs of update-catalog entries, including resource types (platforms), components, and update packages to refresh</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-LXCOFirmwareCatalog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Download</maml:name> <maml:description> <maml:para>When is specified, the packages from IDs parameter are downloaded into the LXCO repository.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IDs</maml:name> <maml:description> <maml:para>List of IDs of update-catalog entries, including resource types (platforms), components, and update packages to refresh</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirmwareAge</maml:name> <maml:description> <maml:para>When is specified, this parameter indicates which firmware to refresh: all or latest. If is not specified, latest firmware is refreshed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IDs</maml:name> <maml:description> <maml:para>List of IDs of update-catalog entries, including resource types (platforms), components, and update packages to refresh</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Download</maml:name> <maml:description> <maml:para>When is specified, the packages from IDs parameter are downloaded into the LXCO repository.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the refresh or download request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Update-LXCOFirmwareCatalog -IDs "repopack" $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example refresh the information (metadata) for updates specified with IDs parameter.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Update-LXCOFirmwareCatalog -Download -IDs "lnvgy_sw_lxca_systemxrepo4-3.4.0_anyos_noarch","lnvgy_sw_lxca_thinksystemrepo4-3.4.0_anyos_noarch" $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example downloads specified updates from the Lenovo Support website.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOUpdatePolicies</command:name> <maml:description> <maml:para>Returns information about update-compliance policies.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOUpdatePolicies</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns a list of update-compliance policies or returns information about a specific update-compliance policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOUpdatePolicies</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOUpdatePolicies</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the update compliance policy 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"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>If specified, data is saved as a file in JSON format in the specified location. - If a directory is specified (if the string ends with \ or /), the file name is saved as policyName-currentDate.json. Time format is MMDDYYYY-HHmmss. - If the directory does not exist, it is automatically created.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the update compliance policy 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>If specified, data is saved as a file in JSON format in the specified location. - If a directory is specified (if the string ends with \ or /), the file name is saved as policyName-currentDate.json. Time format is MMDDYYYY-HHmmss. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.UpdatePolicyData</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -ID is not specified, this cmdlet returns an array of UpdatePolicyData objects, which contains information about each update-compliance policy.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.UpdatePolicyFullData</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -ID is specified and -OutFile is not specified, this cmdlet returns an UpdatePolicyFullData object, which contains detailed information about the update-compliance policy.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -ID and -OutFile are specified, this cmdlet returns a string with fully-qualified path of the file.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOUpdatePolicies $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example returns a list of update-compliance policies.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOUpdatePolicies -ID 1636021473564 $result | Format-List #show all criteria in this update-policy $result.Rules[0].Criteria |Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example returns a detailed information about a specified update-compliance policy.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOUpdatePolicies -ID 1636021473564 -OutFile $PSScriptRoot\..\test\ $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example returns information about a update-compliance policy as a JSON file named {policy-name}_11052021-132402.json, in the specified location. Time format is MMDDYYYY-HHmmss.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-LXCOUpdatePolicies</command:name> <maml:description> <maml:para>Imports update-compliance policy definitions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>LXCOUpdatePolicies</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet imports one or more files that contain update-compliance policy definitions, in JSON format. Each file can contain only a single policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-LXCOUpdatePolicies</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InFiles</maml:name> <maml:description> <maml:para>Specifies a list of update-compliance policy file names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InFiles</maml:name> <maml:description> <maml:para>Specifies a list of update-compliance policy file names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet returns a RequestStatusMessage object with request status. If an error occurred, RequestStatusMessage.Messages contains an array of StatusMessage objects with details about the policies which failed to be imported.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Import-LXCOUpdatePolicies -InFile Policy_1.json $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example imports an update-compliance policy.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $files = @( "$PSScriptRoot/../test/compliance20.json", "$PSScriptRoot/../test/compliance30.json" ) $result = Import-LXCOUpdatePolicies -InFile $files $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example imports a list of update-compliance policies.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Join-LXCOUpdatePolicy</command:name> <maml:description> <maml:para>Assign an update-compliance policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Join</command:verb> <command:noun>LXCOUpdatePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet assigns an update-compliance policy to specified resources. Use the ComplianceStatus parameter to determine whether to replace an existing policy assignment with the new policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Join-LXCOUpdatePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resource managers or managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Update-compliance policy ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Identifies whether to replace the currently assigned policy with the new policy based on the current policy compliance. This can be one of the following values: - Compliant. The new policy is assigned only to devices that are compliant with the assigned policy. - NotCompliant. The new policy is assigned only to devices that are not compliant with the assigned policy. - NoPolicyAssigned. The new policy is assigned only to devices that do not have an assigned policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Join-LXCOUpdatePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource and device groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Update-compliance policy ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Identifies whether to replace the currently assigned policy with the new policy based on the current policy compliance. This can be one of the following values: - Compliant. The new policy is assigned only to devices that are compliant with the assigned policy. - NotCompliant. The new policy is assigned only to devices that are not compliant with the assigned policy. - NoPolicyAssigned. The new policy is assigned only to devices that do not have an assigned policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Join-LXCOUpdatePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resource managers or managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Update-compliance policy 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"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if another policy is assigned to that platform, the current assigned policy is replaced with the new policy. This is equivalent with specifying ComplianceStatus with all values. If not specified, the current assigned policy (if any) is not changed. This is equivalent with ComplianceStatus having NoPolicyAssigned value. Note: This parameter is deprecated, and it will be removed at a future date. Use ComplianceStatus parameter instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Join-LXCOUpdatePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource and device groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Update-compliance policy 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"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if another policy is assigned to that platform, the current assigned policy is replaced with the new policy. This is equivalent with specifying ComplianceStatus with all values. If not specified, the current assigned policy (if any) is not changed. This is equivalent with ComplianceStatus having NoPolicyAssigned value. Note: This parameter is deprecated, and it will be removed at a future date. Use ComplianceStatus parameter instead.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resource managers or managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Update-compliance policy 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource and device groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if another policy is assigned to that platform, the current assigned policy is replaced with the new policy. This is equivalent with specifying ComplianceStatus with all values. If not specified, the current assigned policy (if any) is not changed. This is equivalent with ComplianceStatus having NoPolicyAssigned value. Note: This parameter is deprecated, and it will be removed at a future date. Use ComplianceStatus parameter instead.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Identifies whether to replace the currently assigned policy with the new policy based on the current policy compliance. This can be one of the following values: - Compliant. The new policy is assigned only to devices that are compliant with the assigned policy. - NotCompliant. The new policy is assigned only to devices that are not compliant with the assigned policy. - NoPolicyAssigned. The new policy is assigned only to devices that do not have an assigned policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If the update-compliance policy was not assigned to all target devices, this cmdlet returns a RequestStatusMessage object that contains information about the devices that were not assigned. If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example assigns a policy to a resource, replacing the existing policy. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Join-LXCOUpdatePolicy -PolicyId 8D735FCEFBCD49118C68169312166C68 ` -ResourceIDs 00632D78DE644E23B712E200FE449787 ` -ComplianceStatus Compliant,NotCompliant $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-LXCOUpdatePolicy</command:name> <maml:description> <maml:para>Creates an update-compliance policy for one platform, with one criteria.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>LXCOUpdatePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet creates an update-compliance policy for a specific platform, with one criterioa and saves this as a json file. This file can then be updated with other platforms and new criteria. This cmdlet does not require a connection to a XClarity Orchestrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-LXCOUpdatePolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the policy 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"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>If specified, data is saved as a file in JSON format in the specified location. - If a directory is specified (if the string ends with \ or /), the file name is saved as policyName-currentDate.json. Time format is MMDDYYYY-HHmmss. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the policy description.</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"> <maml:name>ComplianceRule</maml:name> <maml:description> <maml:para>Specifies the compliance rule. This can be one of the following values. - DoNotFlag. Devices that are out of compliance are not flagged - FlagIfNotExactMatch. If the software or firmware level that is installed on a resource is not an exact match with the update-compliance policy, the resource is flagged as non-compliant. For example, if you replace a network adapter in a server, and the firmware on that network adapter is different than the level identified in the update-compliance policy, then the server is flagged as non-compliant.</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"> <maml:name>PlatformId</maml:name> <maml:description> <maml:para>Specifies the ID of the platform (resource type) that is associated with the target component.</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"> <maml:name>ComponentId</maml:name> <maml:description> <maml:para>Specifies the target component ID Tip: If the target does not have a component, specify the platform 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"> <maml:name>UpdatePackageId</maml:name> <maml:description> <maml:para>Specifies the target update package ID.</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"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the policy 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>If specified, data is saved as a file in JSON format in the specified location. - If a directory is specified (if the string ends with \ or /), the file name is saved as policyName-currentDate.json. Time format is MMDDYYYY-HHmmss. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the policy description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceRule</maml:name> <maml:description> <maml:para>Specifies the compliance rule. This can be one of the following values. - DoNotFlag. Devices that are out of compliance are not flagged - FlagIfNotExactMatch. If the software or firmware level that is installed on a resource is not an exact match with the update-compliance policy, the resource is flagged as non-compliant. For example, if you replace a network adapter in a server, and the firmware on that network adapter is different than the level identified in the update-compliance policy, then the server is flagged as non-compliant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PlatformId</maml:name> <maml:description> <maml:para>Specifies the ID of the platform (resource type) that is associated with the target component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComponentId</maml:name> <maml:description> <maml:para>Specifies the target component ID Tip: If the target does not have a component, specify the platform 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePackageId</maml:name> <maml:description> <maml:para>Specifies the target update package 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <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:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet returns a string with fully qualified path of the file.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$result = New-LXCOUpdatePolicy -Name Policy_1 -OutFile String $PSScriptRoot/../lxco-updates/ ` -ComplianceRule FlagIfNotExactMatch ` -PlatformId lxca -ComponentId lxca ` -UpdatePackageId lnvgy_sw_lxca_102-2.7.0_anyos_noarch $result</dev:code> <dev:remarks> <maml:para>This example creates an update-compliance policy for Lenovo XClarity Administrator.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Split-LXCOUpdatePolicy</command:name> <maml:description> <maml:para>Unassigns an update-compliance policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Split</command:verb> <command:noun>LXCOUpdatePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet unassigns an update-compliance policy from specified resources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Split-LXCOUpdatePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resource managers or managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Split-LXCOUpdatePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource and device groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resource managers or managed devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource and device groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet returns a RequestStatusMessage object with request status.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $resourceIds = @( "69B926D8279411E89ECB7ED30AEC2017-DF5F931E7CA149928C99E84633EA5E9C", "3AB281F826A811E8B58E7ED30AEC214F-DF5F931E7CA149928C99E84633EA5E9C" ) $result = Split-LXCOUpdatePolicy -ResourceIDs $resourceIds $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example unassigns a policy from specified resources.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Install-LXCODeviceFirmwareUpdates</command:name> <maml:description> <maml:para>Apply and activate an update on managed servers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCODeviceFirmwareUpdates</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet applies and activates an update on one or more managed servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LXCODeviceFirmwareUpdates</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Indicates whether to apply the update to selected components even if the current software or firmware level is up to date or to apply an update that is earlier than the one that is currently installed. Important: You cannot apply earlier levels of firmware to device options, adapters, and disk drives. If is specified, applies the update to the selected resources even if the software or firmware is compliant, otherwise skips the update on the selected resources if the software or firmware is already compliant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Indicates when to activate the update. This can be one of the following values: - ImmediateActivation. During the update process, the resource might be restarted automatically several times until the entire process is complete. Ensure that you quiesce all applications on the resource before you proceed. - DelayedActivation. Some but not all update operations are performed. Resources must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes. - PrioritizedActivation. Baseboard Management Controller is applied and activated immediately while other firmware is performed in delayed activation mode.</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"> <maml:name>UpdateRule</maml:name> <maml:description> <maml:para>Indicates how to handle errors during the update process. This can be one of the following values: - ContinueOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the update process does not apply the update for that specific component. However, the orchestrator server continues to update other components for the resource and continues with all other updates in the current update job. - AbortOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the updates process stops the remaining updates for that specific resource. The current firmware that is installed on that resource remains in effect. However, current update job includes additional resources, the orchestrator server continues to update the remaining resources.</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"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>ID of the update-compliance policy The update is applied to each resource that is assigned the policy only if the resource is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCODeviceFirmwareUpdates</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Indicates whether to apply the update to selected components even if the current software or firmware level is up to date or to apply an update that is earlier than the one that is currently installed. Important: You cannot apply earlier levels of firmware to device options, adapters, and disk drives. If is specified, applies the update to the selected resources even if the software or firmware is compliant, otherwise skips the update on the selected resources if the software or firmware is already compliant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Indicates when to activate the update. This can be one of the following values: - ImmediateActivation. During the update process, the resource might be restarted automatically several times until the entire process is complete. Ensure that you quiesce all applications on the resource before you proceed. - DelayedActivation. Some but not all update operations are performed. Resources must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes. - PrioritizedActivation. Baseboard Management Controller is applied and activated immediately while other firmware is performed in delayed activation mode.</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"> <maml:name>UpdateRule</maml:name> <maml:description> <maml:para>Indicates how to handle errors during the update process. This can be one of the following values: - ContinueOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the update process does not apply the update for that specific component. However, the orchestrator server continues to update other components for the resource and continues with all other updates in the current update job. - AbortOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the updates process stops the remaining updates for that specific resource. The current firmware that is installed on that resource remains in effect. However, current update job includes additional resources, the orchestrator server continues to update the remaining resources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resources to which to apply the updates The update is applied to each specified resource only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCODeviceFirmwareUpdates</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Indicates whether to apply the update to selected components even if the current software or firmware level is up to date or to apply an update that is earlier than the one that is currently installed. Important: You cannot apply earlier levels of firmware to device options, adapters, and disk drives. If is specified, applies the update to the selected resources even if the software or firmware is compliant, otherwise skips the update on the selected resources if the software or firmware is already compliant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Indicates when to activate the update. This can be one of the following values: - ImmediateActivation. During the update process, the resource might be restarted automatically several times until the entire process is complete. Ensure that you quiesce all applications on the resource before you proceed. - DelayedActivation. Some but not all update operations are performed. Resources must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes. - PrioritizedActivation. Baseboard Management Controller is applied and activated immediately while other firmware is performed in delayed activation mode.</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"> <maml:name>UpdateRule</maml:name> <maml:description> <maml:para>Indicates how to handle errors during the update process. This can be one of the following values: - ContinueOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the update process does not apply the update for that specific component. However, the orchestrator server continues to update other components for the resource and continues with all other updates in the current update job. - AbortOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the updates process stops the remaining updates for that specific resource. The current firmware that is installed on that resource remains in effect. However, current update job includes additional resources, the orchestrator server continues to update the remaining resources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource group to which to apply the updates The update is applied to each resource in the specified groups only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Indicates whether to apply the update to selected components even if the current software or firmware level is up to date or to apply an update that is earlier than the one that is currently installed. Important: You cannot apply earlier levels of firmware to device options, adapters, and disk drives. If is specified, applies the update to the selected resources even if the software or firmware is compliant, otherwise skips the update on the selected resources if the software or firmware is already compliant.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Indicates when to activate the update. This can be one of the following values: - ImmediateActivation. During the update process, the resource might be restarted automatically several times until the entire process is complete. Ensure that you quiesce all applications on the resource before you proceed. - DelayedActivation. Some but not all update operations are performed. Resources must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes. - PrioritizedActivation. Baseboard Management Controller is applied and activated immediately while other firmware is performed in delayed activation mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRule</maml:name> <maml:description> <maml:para>Indicates how to handle errors during the update process. This can be one of the following values: - ContinueOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the update process does not apply the update for that specific component. However, the orchestrator server continues to update other components for the resource and continues with all other updates in the current update job. - AbortOnError. If an error occurs when updating one of the components in a resource (such as an adapter or management-controller firmware), the updates process stops the remaining updates for that specific resource. The current firmware that is installed on that resource remains in effect. However, current update job includes additional resources, the orchestrator server continues to update the remaining resources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>ID of the update-compliance policy The update is applied to each resource that is assigned the policy only if the resource is out of compliance with that 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resources to which to apply the updates The update is applied to each specified resource only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource group to which to apply the updates The update is applied to each resource in the specified groups only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Install-LXCODeviceFirmwareUpdates -ActivationRule DelayedActivation ` -UpdateRule ContinueOnError ` -ResourceIDs 69B926D8279411E89ECB7ED30AEC2017-DF5F931E7CA149928C99E84633EA5E9C $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example applies updates to the specified devices that are out of compliance with their assigned update-compliance policy. Some but not all update operations are performed. Resources must be restarted manually to continue the update process. Additional restarts are then performed until the update operation completes. If errors occur during the update, the update continues. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Install-LXCODeviceFirmwareUpdates -ActivationRule ImmediateActivation ` -UpdateRule AbortOnError ` -PolicyId 1636021473202 $result Disconnect-LXCO </dev:code> <dev:remarks> <maml:para>This example applies updates to all non-compliant resources that are assigned to the specified compliance policy. The resources are restarted to activate the update. If errors occur during the update, the update to aborted.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Install-LXCOResourceManagerUpdates</command:name> <maml:description> <maml:para>Apply and activate an update on resource managers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>LXCOResourceManagerUpdates</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet applies and activates an update on one or more resource managers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LXCOResourceManagerUpdates</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>ID of the update-compliance policy The update is applied to each resource that is assigned the policy only if the resource is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCOResourceManagerUpdates</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resources to which to apply the updates The update is applied to each specified resource only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-LXCOResourceManagerUpdates</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource group to which to apply the updates The update is applied to each resource in the specified groups only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>ID of the update-compliance policy The update is applied to each resource that is assigned the policy only if the resource is out of compliance with that 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>List of IDs of resources to which to apply the updates The update is applied to each specified resource only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupIDs</maml:name> <maml:description> <maml:para>List of IDs of resource group to which to apply the updates The update is applied to each resource in the specified groups only if the resource has an assigned compliance policy and is out of compliance with that policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Install-LXCOResourceManagerUpdates -GroupIDs G_85A42D160E83469B9746B96303597115 $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>This example applies updates to the resource managers in the specified group that are out of compliance with their assigned update-compliance policy. The resources are restarted to activate the update. If errors occur during the update, the update continues. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOAlerts</command:name> <maml:description> <maml:para>Returns a list of alerts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOAlerts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns a list of alerts or a specific alert from Lenovo XClarity Orchestrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOAlerts</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the alert to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOAlerts</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Excluded</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of all excluded alerts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity. This can be one of the following values: - Informational. - Warning. - Critical.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All alerts that contain the specified pattern 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"> <maml:name>System</maml:name> <maml:description> <maml:para>Specifies the full or partial resource name. All alerts that contain the specified pattern 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"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All alerts that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertDate</maml:name> <maml:description> <maml:para>Specifies the alert dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOAlerts</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveAlerts</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of all active alerts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Serviceability</maml:name> <maml:description> <maml:para>Specifies the serviceability. This can be one of the following values: - None. - Serviceable. - User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity. This can be one of the following values: - Informational. - Warning. - Critical.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All alerts that contain the specified pattern 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"> <maml:name>System</maml:name> <maml:description> <maml:para>Specifies the full or partial resource name. All alerts that contain the specified pattern 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"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All alerts that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertDate</maml:name> <maml:description> <maml:para>Specifies the alert dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type. This can be one of the following values: - Chassis - Server - LXCA - LXCO - Storage - Switch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceType</maml:name> <maml:description> <maml:para>Specifies the source type. This can be one of the following values: - Analytics - Device - Management</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the full or partial resource-group name. All alerts that contain the specified 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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the alert to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Excluded</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of all excluded alerts.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity. This can be one of the following values: - Informational. - Warning. - Critical.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All alerts that contain the specified 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>System</maml:name> <maml:description> <maml:para>Specifies the full or partial resource name. All alerts that contain the specified 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All alerts that contain the specified 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlertDate</maml:name> <maml:description> <maml:para>Specifies the alert dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveAlerts</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of all active alerts.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Serviceability</maml:name> <maml:description> <maml:para>Specifies the serviceability. This can be one of the following values: - None. - Serviceable. - User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type. This can be one of the following values: - Chassis - Server - LXCA - LXCO - Storage - Switch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceType</maml:name> <maml:description> <maml:para>Specifies the source type. This can be one of the following values: - Analytics - Device - Management</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the full or partial resource-group name. All alerts that contain the specified 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Alerts.AlertData[]</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -ID is not specified, this cmdlet returns an array of AlertData objects that contains high-level information for each alert.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Alerts.AlertFullData</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If the request was accepted by the orchestrator server, this cmdlet returns an AlertFullData object that contains detailed information about a specific alert.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOAlerts $result|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns information about all alerts.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOAlerts -Excluded ` -AlertDate '1.10.2022 14:30:00' ` -EventId 2552 ` -Message 25522 ` -Severity Critical ` -System Orchestrator $result|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns information about excluded alerts.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOAlerts -ID 0X806F06080A01FF03 $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns a detailed information about a specific alert.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOEvents</command:name> <maml:description> <maml:para>Reurns a list of events.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOEvents</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns a list of events or a specific event from Lenovo XClarity Orchestrator server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOEvents</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the event to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOEvents</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceEvents</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of resource events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity. This can be one of the following values: - Informational. - Warning. - Critical.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Serviceability</maml:name> <maml:description> <maml:para>Specifies the serviceability. This can be one of the following values: - None. - Serviceable. - User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All events that contain the specified pattern 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"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the full or partial ResourceName text. All events that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type. This can be one of the following values: - Chassis - Server - LXCA - LXCO - Storage - Switch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the full or partial resource-group name. All events that contain the specified pattern 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"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All events that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EventDate</maml:name> <maml:description> <maml:para>Specifies the event dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOEvents</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceEvents</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of resource events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Excluded</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of excluded events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All events that contain the specified pattern 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"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the full or partial ResourceName text. All events that contain the specified pattern 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"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All events that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EventDate</maml:name> <maml:description> <maml:para>Specifies the event dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOEvents</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuditEvents</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of audit events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity. This can be one of the following values: - Informational. - Warning. - Critical.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Serviceability</maml:name> <maml:description> <maml:para>Specifies the serviceability. This can be one of the following values: - None. - Serviceable. - User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All events that contain the specified pattern 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"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the full or partial ResourceName text. All events that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type. This can be one of the following values: - Chassis - Server - LXCA - LXCO - Storage - Switch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the full or partial resource-group name. All events that contain the specified pattern 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"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All events that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EventDate</maml:name> <maml:description> <maml:para>Specifies the event dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the full or partial user name. All events that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOEvents</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuditEvents</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of audit events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Excluded</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of excluded events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All events that contain the specified pattern 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"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the full or partial ResourceName text. All events that contain the specified pattern 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"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All events that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EventDate</maml:name> <maml:description> <maml:para>Specifies the event dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the ID of the event to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceEvents</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of resource events.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity. This can be one of the following values: - Informational. - Warning. - Critical.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Serviceability</maml:name> <maml:description> <maml:para>Specifies the serviceability. This can be one of the following values: - None. - Serviceable. - User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the full or partial message text. All events that contain the specified 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the full or partial ResourceName text. All events that contain the specified 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type. This can be one of the following values: - Chassis - Server - LXCA - LXCO - Storage - Switch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the full or partial resource-group name. All events that contain the specified 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventId</maml:name> <maml:description> <maml:para>Specifies the full or partial event code. All events that contain the specified 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EventDate</maml:name> <maml:description> <maml:para>Specifies the event dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Excluded</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of excluded events.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuditEvents</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns a list of audit events.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the full or partial user name. All events that contain the specified 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Alerts.EventData[]</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -ID is not specified, this cmdlet returns an array of EventData objects that contains high-level information for each event.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Alerts.EventFullData</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -ID is specified, this cmdlet returns an EventFullData object that contains detailed information about a specific event.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOEvents -AuditEvents $result|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns information about all audit events.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOEvents -ResourceEvents -Excluded $result|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns information about all excluded resource events.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOEvents -ID 0X806F06080A01FF03 $result|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns a detailed information about a specific event.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOEvents -ResourceEvents ` -EventDate "1.10.2022 14:30:00","1.12.2022 11:45:00" ` -EventId FD243 ` -GroupName GRP ` -ResourceType Server ` -Serviceability User ` -Severity Critical $result|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para>The following example returns the not excluded resource events, which meet the specified filtering criterion.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-LXCOFirmwarePackage</command:name> <maml:description> <maml:para>Import one or more update packages.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>LXCOFirmwarePackage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to import one or more update packages. Each update package contains a set of four files: metadata (.xml), payload (.tar.gz, .zip, .tgz, .bin, .tar, or .uxz), readme (.txt) and changelog (.chg). </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-LXCOFirmwarePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Files</maml:name> <maml:description> <maml:para>Specifies a list of files that represents packages to upload.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-LXCOFirmwarePackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FixIDs</maml:name> <maml:description> <maml:para>Specifies a list of patterns to match update packages that are stored in folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the location where the update packages are stored.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Files</maml:name> <maml:description> <maml:para>Specifies a list of files that represents packages to upload.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FixIDs</maml:name> <maml:description> <maml:para>Specifies a list of patterns to match update packages that are stored in folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specifies the location where the update packages are stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJobFullData</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If request succeed, this cmdlet returns a LXCOJobFullData object, which contains details about the status of the operation that is associated with this request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example uploads a firmware package using a list of files. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $files = @( "D:\FirmwareRepository\oem_fw_dsa_dsaoa6s-10.1_anyos_32-64.txt", "D:\FirmwareRepository\oem_fw_dsa_dsaoa6s-10.1_anyos_32-64.uxz", "D:\FirmwareRepository\oem_fw_dsa_dsaoa6s-10.1_anyos_32-64.xml1", "D:\FirmwareRepository\oem_fw_dsa_dsaoa6s-10.1_anyos_anycpu.chg" ) $result = Import-LXCOFirmwarePackage -Files $files $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example uploads three firmware packages from a folder. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $fixIDs_two = @( "lnvgy_fw_xcc_tei3c4m-5.00_anyos_noarch", "lnvgy_utl_uxsp_elsp17p-1.00_windows_32-64", "oem_fw_dsa_dsaoa6s-10.1_anyos" ) $result = Import-LXCOFirmwarePackage -Folder D:\FirmwareRepository\ -FixIDs $fixIDs $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Invoke-LXCOServerPowerAction</command:name> <maml:description> <maml:para>Perform a power action on specified servers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>LXCOServerPowerAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to perform a power action (such as power on or power off) on one or more managed servers.</maml:para> <maml:para>Note: You can perform power actions on a maximum of 25 devices at one time. This means that the number of servers in the groups specified GroupIDs parameter or the number of servers specified in ResourceIDs parameter cannot exceed 25 devices.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-LXCOServerPowerAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>Power action to perform on the specified resources. This can be one of the following values: - PowerOn. Powers on the resource. - PowerOffImmediately. Powers off the resource immediately. - PowerOffNormally. Shuts down the operating system and powers off the resource. - RestartImmediately. Restarts the resource immediately. - RestartNormally. Shuts down the operating system and restarts the resource. - RestartManagementController. Restarts the baseboard management controller. - RestartToSystemSetup. Restarts the resource to BIOS/UEFI (F1) Setup. This is supported for non-ThinkServer servers that are supported without limitations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcesIDs</maml:name> <maml:description> <maml:para>Specifies the server IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-LXCOServerPowerAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>Power action to perform on the specified resources. This can be one of the following values: - PowerOn. Powers on the resource. - PowerOffImmediately. Powers off the resource immediately. - PowerOffNormally. Shuts down the operating system and powers off the resource. - RestartImmediately. Restarts the resource immediately. - RestartNormally. Shuts down the operating system and restarts the resource. - RestartManagementController. Restarts the baseboard management controller. - RestartToSystemSetup. Restarts the resource to BIOS/UEFI (F1) Setup. This is supported for non-ThinkServer servers that are supported without limitations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupsIDs</maml:name> <maml:description> <maml:para>Specifies the device group IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>Power action to perform on the specified resources. This can be one of the following values: - PowerOn. Powers on the resource. - PowerOffImmediately. Powers off the resource immediately. - PowerOffNormally. Shuts down the operating system and powers off the resource. - RestartImmediately. Restarts the resource immediately. - RestartNormally. Shuts down the operating system and restarts the resource. - RestartManagementController. Restarts the baseboard management controller. - RestartToSystemSetup. Restarts the resource to BIOS/UEFI (F1) Setup. This is supported for non-ThinkServer servers that are supported without limitations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcesIDs</maml:name> <maml:description> <maml:para>Specifies the server IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupsIDs</maml:name> <maml:description> <maml:para>Specifies the device group IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJobFullData</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If request succeed, this cmdlet returns a LXCOJobFullData object, which contains details about the status of the operation that is associated with this request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example powers off immediately the specified servers. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $serverIDs = @( "AAABBBCCCDDD-45D937C322664C62B238FEE679314F6F", "EEEFFFDDD000-45D937C322664C62B238FEE679314F6F" ) $result = Invoke-LXCOServerPowerAction -Action PowerOffImmediately ` -ResourcesIDs $serverIDs $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOJobs</command:name> <maml:description> <maml:para>Retrieves job information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOJobs</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to return high-level data for all jobs or a list of jobs, or detailed information for a specific job.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOJobs</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageOffset</maml:name> <maml:description> <maml:para>Use OffsetLimit to specify from what position in server jobs' list, jobs are returned. The default offset is 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageLimit</maml:name> <maml:description> <maml:para>Use PageLimit to specify the number of elements to return at one time. The default limit is 10.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a list of full or partial name text. All jobs that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies a list, comma separated, of job statuses. This can be one of the following values: - Aborted - Blocked - Cancelled - CancelledWithErrors - CancelledWithWarnings - Cancelling - Complete - CompleteWithErrors - CompleteWithWarnings - Expired - Initializing - Interrupted - InterruptedWithErrors - InterruptedWithWarnings - Investigating - Pending - Resolved - Running - RunningWithErrors - RunningWithWarnings - Skipped - Stopped - StoppedWithErrors - StoppedWithWarnings - Unknown - Uploading - Validating - Waiting</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specifies a list of the name of the user that created the job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies a list, comma sepparated, of categories. This can be one of the following values: - Analytics - Backup - Service - Configuration - Custom - Firmware - Health - Inventory - Management - OsDeployment - OsDriverUpdates - OsImport - OsProfileExport - Power - RemoteAccess - SelfMaintenance - SwitchConfiguration - SystemID - Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies a list, comma separated, of full or partial target name text. All jobs that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTimestamp</maml:name> <maml:description> <maml:para>Specifies the job start dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CompleteTimestamp</maml:name> <maml:description> <maml:para>Specifies the job complete dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Progress</maml:name> <maml:description> <maml:para>Specifies a list, comma separated, of job progress. The value should be in 0 - 100 range.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOJobs</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeLogs</maml:name> <maml:description> <maml:para>Whwn speciffied, the logs for the retrieved jobs are returned, if available.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IDs</maml:name> <maml:description> <maml:para>Specifies a list, coma separated, of jobs IDs that are to be returned (high-level data is returned).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOJobs</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>JobID</maml:name> <maml:description> <maml:para>Specifies the job ID that are to be returned (detailed information is returned).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChildrenLevel</maml:name> <maml:description> <maml:para>Levels of subtasks to return. This can be one of the following values: -1. All subtasks are returned. 0. (default) No subtasks are returned. {number}. The specified level of subtasks is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeLogs</maml:name> <maml:description> <maml:para>Whwn speciffied, the logs for the retrieved jobs are returned, if available.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageOffset</maml:name> <maml:description> <maml:para>Use OffsetLimit to specify from what position in server jobs' list, jobs are returned. The default offset is 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageLimit</maml:name> <maml:description> <maml:para>Use PageLimit to specify the number of elements to return at one time. The default limit is 10.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a list of full or partial name text. All jobs that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies a list, comma separated, of job statuses. This can be one of the following values: - Aborted - Blocked - Cancelled - CancelledWithErrors - CancelledWithWarnings - Cancelling - Complete - CompleteWithErrors - CompleteWithWarnings - Expired - Initializing - Interrupted - InterruptedWithErrors - InterruptedWithWarnings - Investigating - Pending - Resolved - Running - RunningWithErrors - RunningWithWarnings - Skipped - Stopped - StoppedWithErrors - StoppedWithWarnings - Unknown - Uploading - Validating - Waiting</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specifies a list of the name of the user that created the job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies a list, comma sepparated, of categories. This can be one of the following values: - Analytics - Backup - Service - Configuration - Custom - Firmware - Health - Inventory - Management - OsDeployment - OsDriverUpdates - OsImport - OsProfileExport - Power - RemoteAccess - SelfMaintenance - SwitchConfiguration - SystemID - Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies a list, comma separated, of full or partial target name text. All jobs that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTimestamp</maml:name> <maml:description> <maml:para>Specifies the job start dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CompleteTimestamp</maml:name> <maml:description> <maml:para>Specifies the job complete dates as range, using the following format: <startDate>,<endDate>. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Progress</maml:name> <maml:description> <maml:para>Specifies a list, comma separated, of job progress. The value should be in 0 - 100 range.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeLogs</maml:name> <maml:description> <maml:para>Whwn speciffied, the logs for the retrieved jobs are returned, if available.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChildrenLevel</maml:name> <maml:description> <maml:para>Levels of subtasks to return. This can be one of the following values: -1. All subtasks are returned. 0. (default) No subtasks are returned. {number}. The specified level of subtasks is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IDs</maml:name> <maml:description> <maml:para>Specifies a list, coma separated, of jobs IDs that are to be returned (high-level data is returned).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>JobID</maml:name> <maml:description> <maml:para>Specifies the job ID that are to be returned (detailed information is returned).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob[]</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -JobID is not specified, this cmdlet return an array of LXCOJob objects, that contains high-level information for each job.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJobFullData</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -JobID is specified, this cmdlet returns a LXCOJobFullData object, that contains detailed information about a specific job.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example return all jobs that meet the specified filters. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $jobs = Get-LXCOJobs -Category Firmware ` -Status RunningWithErrors,RunningWithWarnings ` -Progress 10,50 ` -StartTimestamp "1.10.2022 14:30:00","1.12.2022 11:45:00" ` -CompleteTimestamp "1.10.2022 14:30:00","1.12.2022 11:45:00" $jobs|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example return all specified jobs and the job logs if are available. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $jobs = Get-LXCOJobs -IDs 1,4,7,15 -IncludeLogs $jobs|Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example return specified job and all its subtasks. # Also job logs are retrieved, if available. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $job = Get-LXCOJobs -JobID 1 -ChildrenLevel -1 -IncludeLogs $job # show the content of the level 1 subtasks $job.Children |Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCODeviceInventory</command:name> <maml:description> <maml:para>Retrieves inventory details about a managed device.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCODeviceInventory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns inventory data about a specific managed device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCODeviceInventory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device to return inventory data.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device to return inventory data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.ChassisInventoryInfo</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If device specified by -DeviceId is a chassis, this cmdlet returns a ChassisInventoryInfo object that contains inventory information about the specified device</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.SwitchInventoryInfo</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If device specified by -DeviceId is a switch, this cmdlet returns a SwitchInventoryInfo object that contains inventory information about the specified device</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.StorageInventoryInfo</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If device specified by -DeviceId is a storage, this cmdlet returns a StorageInventoryInfo object that contains inventory information about the specified device</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.ServerInventoryInfo</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If device specified by -DeviceId is a server, this cmdlet returns a ServerInventoryInfo object that contains inventory information about the specified device</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example returns inventory data about a specific device. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCODeviceInventory -DeviceID 00632D78DE644E23B712E200FE449787-7AF5D198CECF431AAEC674C7CA5A29B5 $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOServiceData</command:name> <maml:description> <maml:para>Gets the FFDC file from the Lenovo XClarity Orchestrator server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOServiceData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet downloads the first failure data capture (FFDC) file for Lenovo XClarity Orchestrator to the local system. Downloaded file is an archive of tar.gz type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOServiceData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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 do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name, provided by the orchestrator, LXCO_Service_Data_<date>_<time>.tar.gz is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if the file already exists in the specified directory, the file is overwritten. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_ffdc_file_path> file already exists exception is thrown.</maml:para> </maml:description> <command:parameterValue required="false" 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"> <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 do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name, provided by the orchestrator, LXCO_Service_Data_<date>_<time>.tar.gz is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if the file already exists in the specified directory, the file is overwritten. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_ffdc_file_path> file already exists exception is thrown.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <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:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet downloads the XClarity Orchestrator service-data file to the specified directory on the local system and returns a System.String object that contains the full path of the saved file</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example downloads the FFDC file, saves it on the local system, and prints the file's fully qualified path to the PS console. # If a file with same name already exists, the file is overwritten. $cred = Get-Credential Connect-LXCA -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Get-LXCOServiceData -Destination C:\LXCOServiceData\ffdc.tar.gz -Overwrite) #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example downloads the FFDC file, saves it on the local system, and prints the file's fully qualified path to the PS console. # The file name used is the one that is returned by XClarity Orchestrator. $cred = Get-Credential Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Get-LXCOServiceData -Destination C:\LXCOServiceData\) #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCODeviceServiceData</command:name> <maml:description> <maml:para>Returns a list of all service-data archives or saves to the local system ,one or more specific service-data archives for one or more devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCODeviceServiceData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns a list of all service-data archives or saves to the local system, one or more specific service-data archives for one or more devices.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCODeviceServiceData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ArchiveName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial archive names, separated by a comma. All archives that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the name of one or more devices that are associated with the service data archive, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupsName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial resource-group names, separated by a comma. All service files that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeStamp</maml:name> <maml:description> <maml:para>Specifies the timestamp when the service data files were collected, as range, using the following format: <startDate>,<endDate>. The end date is optional. If not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCODeviceServiceData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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 do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name, provided by the orchestrator, is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if the file already exists in the specified directory, the file is overwritten. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_ffdc_file_path> file already exists exception is thrown.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FfdcIDs</maml:name> <maml:description> <maml:para>Specifies the IDs of the service files to download, comma separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCODeviceServiceData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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 do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name, provided by the orchestrator, is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if the file already exists in the specified directory, the file is overwritten. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_ffdc_file_path> file already exists exception is thrown.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>Specifies the Ds of the devices for which service files are downloaded, comma separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CollectLatest</maml:name> <maml:description> <maml:para>When specified, the latest service data for devices specified by -ResourceUUIDs is collected and downloaded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCODeviceServiceData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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 do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name, provided by the orchestrator, is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if the file already exists in the specified directory, the file is overwritten. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_ffdc_file_path> file already exists exception is thrown.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ArchiveName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial archive names, separated by a comma. All archives that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceName</maml:name> <maml:description> <maml:para>Specifies the name of one or more devices that are associated with the service data archive, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupsName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial resource-group names, separated by a comma. All service files that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeStamp</maml:name> <maml:description> <maml:para>Specifies the timestamp when the service data files were collected, as range, using the following format: <startDate>,<endDate>. The end date is optional. If not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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 do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name, provided by the orchestrator, is used. - If the directory does not exist, it is automatically created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if the file already exists in the specified directory, the file is overwritten. If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_ffdc_file_path> file already exists exception is thrown.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FfdcIDs</maml:name> <maml:description> <maml:para>Specifies the IDs of the service files to download, comma separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CollectLatest</maml:name> <maml:description> <maml:para>When specified, the latest service data for devices specified by -ResourceUUIDs is collected and downloaded.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceIDs</maml:name> <maml:description> <maml:para>Specifies the Ds of the devices for which service files are downloaded, comma separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.DeviceServiceDataDetails[]</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the -Destination parameter is not supplied, this cmdlet returns a DeviceServiceDataDetails[] array that contains information about all service-data archives.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If the -Destination parameter is specified, this cmdlet downloads the devices service-data file to the specified directory on the local system and returns a System.String object that contains the full path of the saved file</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>You cannot pipe objects to this cmdlet. The returned file is a tar.gz archive if more then one device FFDC is downloaded, or a tzz archive if one FFDC file is downloaded.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example retrieve the existing service-data files details. $cred = Get-Credential Connect-LXCA -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $details = Get-LXCODeviceServiceData -TimeStamp "1.10.2022 14:30:00","1.12.2022 11:45:00" # show the result $details #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example downloads existing device service-data files, saves it on the local system, and prints the file's fully qualified path to the PS console. # The file name used is the one that is returned by XClarity Orchestrator. $cred = Get-Credential Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $(Get-LXCODeviceServiceData -Destination C:\LXCODeviceServiceData\) #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example downloads existing service-data files which are specified by file id, saves it on the local system, and prints the file's fully qualified path to the PS console. # The file name used is the one that is returned by XClarity Orchestrator. $cred = Get-Credential Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $ffdcIDs = @( "94b863c9000f7882143fc7e17ed29d98e08bb538", "813c6d127cf1be6d2bdeda09d03dde79c3dcf41c", "84267e359065775b3b7d85a10bda2a39ec52d999" ) $(Get-LXCODeviceServiceData -Destination C:\LXCODeviceServiceData\ -FfdcIDs $ffdcIDs) #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example collect the latest service-data files for the devices specified by -ResourceUUIDs # and saves it on the local system, and prints the file's fully qualified path to the PS console. # The file name used is the one that is returned by XClarity Orchestrator. $cred = Get-Credential Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $uuids = @( "92E7C1B5912911E6A0599DE30E1BEFFB-94084F7CDA0E4CFB999DE392A458B778", "640CD4D706E711E8A391BD658DF61E04-94084F7CDA0E4CFB999DE392A458B778" ) $(Get-LXCODeviceServiceData -Destination C:\LXCODeviceServiceData\ -ResourceIDs $uuids -CollectLatest) #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCODevicesConfiguration</command:name> <maml:description> <maml:para>Retrieve informaton about the configuration patterns for devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCODevicesConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns details about the configuration pattern status for managed servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCODevicesConfiguration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Specifies the compliance status of the devices to be returned. This can be one or more of the following values, separated by comma: - Compliant, - DeployFailed - NoPatternAssigned - Noncompliant - PendingComplianceCheck - PendingRestart</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceStatus</maml:name> <maml:description> <maml:para>Specifies the status of the devices to be returned. This can be one or more of the following values, separated by comma: - Critical - Normal - Warning</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedPattern</maml:name> <maml:description> <maml:para>Specifies one or more full or partial assigned patterns names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial device names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial resource-group names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Specifies the compliance status of the devices to be returned. This can be one or more of the following values, separated by comma: - Compliant, - DeployFailed - NoPatternAssigned - Noncompliant - PendingComplianceCheck - PendingRestart</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceStatus</maml:name> <maml:description> <maml:para>Specifies the status of the devices to be returned. This can be one or more of the following values, separated by comma: - Critical - Normal - Warning</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedPattern</maml:name> <maml:description> <maml:para>Specifies one or more full or partial assigned patterns names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial device names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial resource-group names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.DeviceConfigPatternDetails[]</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If request is successful, this cmdlet returns a DeviceConfigPatternDetails[] array that contains information about configuration patterns.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example returns all devices that are not compliant and have Normal or Warning status $cred = Get-Credential Connect-LXCA -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $details = Get-LXCODevicesConfiguration -ComplianceStatus Noncompliant ` -DeviceStatus Normal,Warning # show the result $details #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOResourcesCompliance</command:name> <maml:description> <maml:para>Retrieve informaton about the firmware compliances for devices or resource managers. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOResourcesCompliance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns details about the firmware compliances for managed devices or registered resource managers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOResourcesCompliance</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceManagers</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns updates-compliance details for registered resource managers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status of the devices or managers to be returned. This can be one or more of the following values, separated by comma: - Critical - Normal - Warning - Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Specifies the compliance status of the devices or managers to be returned. This can be one or more of the following values, separated by comma: - CalculatingPolicy, - Compliant, - NoPolicyAssigned, - NotCompliant, - Pending, - Updating</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a list of full or partial name text. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InstalledVersion</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version number for updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version build number (identifier) for updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedCompliancePolicy</maml:name> <maml:description> <maml:para>Specifies a list of full or partial compliance policy names. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceTarget</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version number for target in updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceTargetBuildNumber</maml:name> <maml:description> <maml:para>Specifies a list of full or partial build number (identififier) for target in updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies one or more full or partial resource-group names, separated by a comma. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOResourcesCompliance</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Devices</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns firmware-compliance details for managed devices.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status of the devices or managers to be returned. This can be one or more of the following values, separated by comma: - Critical - Normal - Warning - Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Specifies the compliance status of the devices or managers to be returned. This can be one or more of the following values, separated by comma: - CalculatingPolicy, - Compliant, - NoPolicyAssigned, - NotCompliant, - Pending, - Updating</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a list of full or partial name text. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InstalledVersion</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version number for updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version build number (identifier) for updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedCompliancePolicy</maml:name> <maml:description> <maml:para>Specifies a list of full or partial compliance policy names. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceTarget</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version number for target in updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceTargetBuildNumber</maml:name> <maml:description> <maml:para>Specifies a list of full or partial build number (identififier) for target in updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies one or more full or partial resource-group names, separated by a comma. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connectivity</maml:name> <maml:description> <maml:para>Specifies the connectivity status of devices to return. This can be one or more of the following values, separated by a comma: - Online - Offline - Partial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial product names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>Specifies one or more full or partial machine types, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>Specifies one or more full or partial serial numbers, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceManagers</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns updates-compliance details for registered resource managers.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status of the devices or managers to be returned. This can be one or more of the following values, separated by comma: - Critical - Normal - Warning - Unknown</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Specifies the compliance status of the devices or managers to be returned. This can be one or more of the following values, separated by comma: - CalculatingPolicy, - Compliant, - NoPolicyAssigned, - NotCompliant, - Pending, - Updating</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a list of full or partial name text. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InstalledVersion</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version number for updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version build number (identifier) for updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignedCompliancePolicy</maml:name> <maml:description> <maml:para>Specifies a list of full or partial compliance policy names. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceTarget</maml:name> <maml:description> <maml:para>Specifies a list of full or partial version number for target in updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComplianceTargetBuildNumber</maml:name> <maml:description> <maml:para>Specifies a list of full or partial build number (identififier) for target in updates' components. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies one or more full or partial resource-group names, separated by a comma. All devices or resource managers that contain the specified pattern are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Devices</maml:name> <maml:description> <maml:para>When specified, this cmdlet returns firmware-compliance details for managed devices.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connectivity</maml:name> <maml:description> <maml:para>Specifies the connectivity status of devices to return. This can be one or more of the following values, separated by a comma: - Online - Offline - Partial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductName</maml:name> <maml:description> <maml:para>Specifies one or more full or partial product names, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>Specifies one or more full or partial machine types, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>Specifies one or more full or partial serial numbers, separated by a comma. A list of all devices that match specified pattern is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.DeviceFirmwareComplianceDetails[]</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -Devices parameter is specified, this cmdlet returns a DeviceFirmwareComplianceDetails[] array that contains information about firmware compliance for managed devices</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.Devices.ResourceManagerUpdateComplianceDetails[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -ResouceManager is specified, this cmdlet returns a ResourceManagerUpdateComplianceDetails[] array that contains information about compliance status.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example returns all devices that are not compliant or # doesn't have a policy assigned and have Normal or Warning status $cred = Get-Credential Connect-LXCA -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $details = Get-LXCOResourcesCompliance -Devices ` -ComplianceStatus NoPolicyAssigned,NotCompliant ` -Status Normal,Warning # show the result $details #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example returns all resource managers that doesn't have a policy assigned and have Critical status $cred = Get-Credential Connect-LXCA -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck $details = Get-LXCOResourcesCompliance -ResourceManagers ` -ComplianceStatus NoPolicyAssigned ` -Status Critical # show the result $details #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-LXCOServerConfigPattern</command:name> <maml:description> <maml:para>This cmdlet creates a server-configuration pattern by learning the pattern of an existing server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>LXCOServerConfigPattern</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet creates a server-configuration pattern by learning the pattern of an existing server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the pattern type. This value is always learn.</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"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the pattern name. Tip: The following characters are not allowed: ! ~ ` # $ % ^ & ; ' < > { } ? | " \</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"> <maml:name>DeviceUUID</maml:name> <maml:description> <maml:para>Specifies server UUID for which you want to learn a pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the pattern description. Tip: The following characters are not allowed: ! ~ ` # $ ^ ; ' < > ? " \</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the pattern type. This value is always learn.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the pattern name. Tip: The following characters are not allowed: ! ~ ` # $ % ^ & ; ' < > { } ? | " \</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceUUID</maml:name> <maml:description> <maml:para>Specifies server UUID for which you want to learn a pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the pattern description. Tip: The following characters are not allowed: ! ~ ` # $ ^ ; ' < > ? " \</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the xClarity Orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the learn server-config request.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns an RequestStatusMessage object that contains information about the reason of the failure</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example learn a configuration pattern from the specified device. $cred = Get-Credential Connect-LXCA -HostUri "192.0.2.0" -Credential $Cred –SkipCertificateCheck $result = New-LXCOServerConfigPattern -DeviceUUID 40EA1D96BCB5B70137D0EDF9DD4B20F9 ` -Name "R365 pattern" $result #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-LXCOServerConfigPattern</command:name> <maml:description> <maml:para>This cmdlet returns information about server-configuration patterns.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>LXCOServerConfigPattern</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet returns a list of server-configuration patterns or details about a specific server-configuration pattern.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more full or partial pattern names, separated by a comma. A list of all patterns that match the specified names is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies one or more full or partial pattern descriptions, separated by a comma. A list of all patterns that match the specified descriptions is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LastUpdate</maml:name> <maml:description> <maml:para>Specifies the last update timestamp, as range using the following format: {startDate},{endDate}. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the update compliance policy 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"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>If specified, data is saved as a file in JSON format in the specified location. If a directory is specified (if the string ends with \ or /), the file name is saved as {pattern_name}-{current_timestamp}.json. The timestamp format is MMDDYYYY-HHMMss.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If specified, the file is overwritten if it exists in the specified directory. If not specified, and if the file exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_config-pattern_file_path> file already exists exception is thrown.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more full or partial pattern names, separated by a comma. A list of all patterns that match the specified names is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies one or more full or partial pattern descriptions, separated by a comma. A list of all patterns that match the specified descriptions is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LastUpdate</maml:name> <maml:description> <maml:para>Specifies the last update timestamp, as range using the following format: {startDate},{endDate}. The end date is optional. If is not specified, the current date is used by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the update compliance policy 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If specified, the file is overwritten if it exists in the specified directory. If not specified, and if the file exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_config-pattern_file_path> file already exists exception is thrown.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>If specified, data is saved as a file in JSON format in the specified location. If a directory is specified (if the string ends with \ or /), the file name is saved as {pattern_name}-{current_timestamp}.json. The timestamp format is MMDDYYYY-HHMMss.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name> System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.ConfigPatternData</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If -ID is not specified, this cmdlet returns a ConfigPatternData[] array which contains details about the existing config patterns.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> System.String</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If -ID is specified, this cmdlet returns a string, and depending on other parameters, the string represent: - the config pattern, as JSON - the path where the config pattern was saved as a file (when -Destination parameter is specified)</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example returns a list of all patterns. Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOServerConfigPattern $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example returns information about specific pattern as a JSON file in the specified location. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOServerConfigPattern -ID 1636021473564 -OutFile $PSScriptRoot\..\test\ $result Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example returns a list of patterns that match specific criteria. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Get-LXCOServerConfigPattern -Name SR350 -LastUpdate "8/25/2022 9:22:34" $result | Format-List Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-LXCOServerConfigPattern</command:name> <maml:description> <maml:para>This cmdlet imports one file that contain server-configuration pattern definitions, in JSON format. The file can contain only a single pattern.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>LXCOServerConfigPattern</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet imports one file that contain server-configuration pattern definitions, in JSON format. The file can contain only a single pattern. Important: - If you modify a server-configuration pattern, do not delete the original pattern before importing the modified pattern. - You cannot import a modified server-configuration pattern to another Lenovo XClarity Orchestrator instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Specifies the file that contains the server-configuration pattern data.</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"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the pattern name. Tip: The following characters are not allowed: ! ~ ` # $ % ^ & ; ' < > { } ? | " \</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the pattern description. Tip: The following characters are not allowed: ! ~ ` # $ ^ ; ' < > ? " \</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Specifies the file that contains the server-configuration pattern data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the pattern name. Tip: The following characters are not allowed: ! ~ ` # $ % ^ & ; ' < > { } ? | " \</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the pattern description. Tip: The following characters are not allowed: ! ~ ` # $ ^ ; ' < > ? " \</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <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:uri> <maml:description/> </dev:type> <maml:description> <maml:para>This cmdlet returns a string which represents the id of the imported pattern.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example import a server-configuration pattern stored in a file. $cred = Get-Credential Connect-LXCA -HostUri "192.0.2.0" -Credential $Cred –SkipCertificateCheck $result = Import-LXCOServerConfigPattern -Name "modiffied pattern" ` -Description "this is a modified configuration pattern for server A" ` -InFile "c:/config-patterns-store/config_for_server_A.json" $result #Disconnect from LXCO Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Join-LXCOServerConfigPattern</command:name> <maml:description> <maml:para>This cmdlet assigns a configuration pattern to specified devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Join</command:verb> <command:noun>LXCOServerConfigPattern</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet assigns a configuration pattern to specified devices.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Join-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PatternID</maml:name> <maml:description> <maml:para>Specifies the configuration-pattern ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceUUIDs</maml:name> <maml:description> <maml:para>Specifies list of UUIDs of devices, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if another pattern is assigned to that device, the current assigned pattern is replaced with the new policy. If not specified, the current assigned pattern (if any) is not changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Join-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PatternID</maml:name> <maml:description> <maml:para>Specifies the configuration-pattern ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies list of IDs of device groups, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if another pattern is assigned to that device, the current assigned pattern is replaced with the new policy. If not specified, the current assigned pattern (if any) is not changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Join-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PatternID</maml:name> <maml:description> <maml:para>Specifies the configuration-pattern 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"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if another pattern is assigned to that device, the current assigned pattern is replaced with the new policy. If not specified, the current assigned pattern (if any) is not changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllServers</maml:name> <maml:description> <maml:para>If specified, the configuration pattern is assigned to all managed servers.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PatternID</maml:name> <maml:description> <maml:para>Specifies the configuration-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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceUUIDs</maml:name> <maml:description> <maml:para>Specifies list of UUIDs of devices, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specified, if another pattern is assigned to that device, the current assigned pattern is replaced with the new policy. If not specified, the current assigned pattern (if any) is not changed.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies list of IDs of device groups, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllServers</maml:name> <maml:description> <maml:para>If specified, the configuration pattern is assigned to all managed servers.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name> System.String[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the request</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If the configuration-pattern was not assigned to all target devices, this cmdlet returns a RequestStatusMessage object that contains information about the devices that were not assigned. If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example assigns a pattern to specified devices, replacing the existing pattern. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Join-LXCOServerConfigPattern -DeviceUUIDs 00632D78DE644E23B712E200FE449787,349D0AD7A3AF11EA9F5F994620EB76C6 ` -PatternID 7757e42210003` -Overwrite Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example assigns a pattern to all managed devices, replacing the existing pattern. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Join- LXCOServerConfigPattern -PatternID 7757e42210003 ` -AllServers ` -Overwrite Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Split-LXCOServerConfigPattern</command:name> <maml:description> <maml:para>Unassigns a configuration pattern from the specified devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Split</command:verb> <command:noun>LXCOServerConfigPattern</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Unassigns a configuration pattern from the specified devices</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Split-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceUUIDs</maml:name> <maml:description> <maml:para>Specifies list of UUIDs of devices, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Split-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies list of IDs of device groups, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Split-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllServers</maml:name> <maml:description> <maml:para>If specified, the configuration pattern is removed from all managed servers.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceUUIDs</maml:name> <maml:description> <maml:para>Specifies list of UUIDs of devices, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies list of IDs of device groups, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllServers</maml:name> <maml:description> <maml:para>If specified, the configuration pattern is removed from all managed servers.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the request</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example removes existing pattern from the specified devices. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Split-LXCOServerConfigPattern -DeviceUUIDs 00632D78DE644E23B712E200FE449787,349D0AD7A3AF11EA9F5F994620EB76C6 Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example removes existing pattern from all managed devices. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Split-LXCOServerConfigPattern -AllServers Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Use-LXCOServerConfigPattern</command:name> <maml:description> <maml:para>Deploy a server configuration pattern to one or more servers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Use</command:verb> <command:noun>LXCOServerConfigPattern</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet creates a job to deploy a server configuration pattern to one or more servers. When the pattern is deployed, Lenovo XClarity Orchestrator modifies the settings on each server to match the settings in the assigned server-configuration pattern.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Use-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Specifies when to activate the configuration. This can be one of the following values. - DeferredActivation. (default) Activates management-controller settings but do not restart the server. UEFI settings are activated after the next restart of the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceUUIDs</maml:name> <maml:description> <maml:para>Specifies list of UUIDs of devices, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Use-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Specifies when to activate the configuration. This can be one of the following values. - DeferredActivation. (default) Activates management-controller settings but do not restart the server. UEFI settings are activated after the next restart of the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies list of IDs of device groups, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Use-LXCOServerConfigPattern</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Specifies when to activate the configuration. This can be one of the following values. - DeferredActivation. (default) Activates management-controller settings but do not restart the server. UEFI settings are activated after the next restart of the 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"> <maml:name>AllServers</maml:name> <maml:description> <maml:para>If specified, the configuration pattern is deployed to all managed servers.</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"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies the connection information to the Lenovo xClarity Orchestrator server. If no connection is specified, the results from the last Connect-LXCO cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LXCOConnection</command:parameterValue> <dev:type> <maml:name>LXCOConnection</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivationRule</maml:name> <maml:description> <maml:para>Specifies when to activate the configuration. This can be one of the following values. - DeferredActivation. (default) Activates management-controller settings but do not restart the server. UEFI settings are activated after the next restart of the 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceUUIDs</maml:name> <maml:description> <maml:para>Specifies list of UUIDs of devices, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Specifies list of IDs of device groups, separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllServers</maml:name> <maml:description> <maml:para>If specified, the configuration pattern is deployed to all managed servers.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOConnection</maml:name> <maml:uri></maml:uri> <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/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name> System.String[]</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para>If the request was accepted by the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the request</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name> Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para> If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>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:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example deploys assigned pattern to specified devices. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Use-LXCOServerConfigPattern -DeviceUUIDs 00632D78DE644E23B712E200FE449787,349D0AD7A3AF11EA9F5F994620EB76C6 ` -ActivationRule DeferredActivation Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code># # The following example deploys assigned pattern to all devices. $cred = Get-Credential Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck $result = Use-LXCOServerConfigPattern -AllServers ` -ActivationRule DeferredActivation Disconnect-LXCO</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |