Lenovo XClarity Administrator Python Toolkit Reference

Transcription

1 Lenovo XClarity Administrator Python Toolkit Reference Version 2.0.0

2 Note Before using this information and the product it supports, read the general and legal notices in the Lenovo XClarity Administrator online documentation. First Edition (March 2018) Copyright Lenovo 2016, LIMITED AND RESTRICTED RIGHTS NOTICE: If data or software is delivered pursuant a General Services Administration GSA contract, use, reproduction, or disclosure is subject to restrictions set forth in Contract No. GS-35F

3 Contents Summary of changes iii Chapter 1. Lenovo XClarity Administrator Overview Chapter 2. Python (PyLXCA) toolkit... 7 Chapter 3. Installing the Python (PyLXCA) toolkit Chapter 4. Using the Python (PyLXCA) toolkit Python (PyLXCA) toolkit examples Creating custom views diagram conventions Chapter 5. PyLXCA commands reference chassis cmms configpatterns configprofiles configtargets connect disconnect discover ffdc fanmuxes fans help jobs log lxcalog manage nodes ostream powersupplies scalablesystem switches unmanage updatecomp updatepolicy updaterepo users Index Copyright Lenovo 2016, 2018 i

4 ii Lenovo XClarity Administrator Python Toolkit Reference

5 Summary of changes Follow-on releases of Lenovo XClarity Administrator management software supports new hardware, software enhancements, and fixes. Refer to the change history file (*.chg) that is provided in the update package for information about fixes. Version Instructions for downloading and installing Python (PyLXCA) toolkit have changed (see Installing the Python (PyLXCA) toolkit). The way you invoke the PyLXCA toolkit has changed (see Using the Python (PyLXCA) toolkit). Version The are no enhancements to the PyLXCA toolkit in this version. Version The are no enhancements to the PyLXCA toolkit in this version. Version This version supports the following enhancements to the Python (PyLXCA) toolkit. The following command was updated: switches on page 31. Added --ports and --action options to displays port information for the specified switch and to enable or disable a specific port. Version This version supports the following enhancements to the Python (PyLXCA) toolkit. The following commands were updated: configprofiles on page 19. The {-v --view} <filter> option is now required. updatecomp on page 33. Each device is specified using a set of properties depending on the type of action specified. manage on page 26. Changed the --mp and --type parameters to be optional, and added the --epuuid parameter to specify the UUID of the device to be managed. Version This version supports the following enhancements to the Python (PyLXCA) toolkit. The following command was updated: updatecomp on page 33. Added the power action to change the power state of a device. Version The are no enhancements to the PyLXCA toolkit in this version. Version This is the first release of the PyLXCA toolkit. Copyright Lenovo 2016, 2018 iii

6 iv Lenovo XClarity Administrator Python Toolkit Reference

7 Chapter 1. Lenovo XClarity Administrator Overview Lenovo XClarity Administrator is a centralized, resource-management solution that simplifies infrastructure management, speeds responses, and enhances the availability of Lenovo server systems and solutions. It runs as a virtual appliance that automates discovery, inventory, tracking, monitoring, and provisioning for server, network, and storage hardware in a secure environment. Learn more: Lenovo XClarity Administrator: Managing hardware like software Lenovo XClarity Administrator: Overview Lenovo XClarity Administrator provides a central interface to perform the following functions for all managed devices. Hardware management Lenovo XClarity Administrator provides agent-free hardware management. It can automatically discover manageable devices, including server, network, and storage hardware. Inventory data is collected for managed devices for an at-a-glance view of the managed hardware inventory and status. There are various management tasks for each supported device, including viewing status and properties, and configuring system and network settings, launching the management interfaces, powering on and off, and remote control. For more information about managing devices, see. Tip: Server, network, and storage hardware that can be managed by Lenovo XClarity Administrator is referred to as devices. Hardware that is under Lenovo XClarity Administrator management is referred to as managed devices. You can use the rack view in Lenovo XClarity Administrator to group your managed devices to reflect the physical rack setup in your datacenter. For more information about racks, see. Learn more: Lenovo XClarity Administrator: Discovery Copyright Lenovo 2016,

8 Lenovo XClarity Administrator: Inventory Lenovo XClarity Administrator: Remote control Hardware monitoring Lenovo XClarity Administrator provides a centralized view of all events and alerts that are generated from the managed devices. An event or alert is passed to the Lenovo XClarity Administrator and is displayed in the events or alerts log. A summary of all events and alerts is visible from the Dashboard and the Status bar. Events and alerts for a specific device are available from the Alerts and Events detail page for that device. For more information about monitoring hardware, see. Learn more: Lenovo XClarity Administrator: Monitoring Configuration management You can quickly provision and pre-provision all of your servers using a consistent configuration. Configuration settings (such as local storage, I/O adapters, boot settings, firmware, ports, and management controller and UEFI settings) are saved as a server pattern that can be applied to one or more managed servers. When the server patterns are updated, the changes are automatically deployed to the applied servers. Server patterns also integrate support for virtualizing I/O addresses, so you can virtualize Flex System fabric connections or repurpose servers without disruption to the fabric. For more information about configuring servers, see. Learn more: Lenovo XClarity Administrator: Bare metal to cluster Lenovo XClarity Administrator: Configuration patterns Firmware compliance and updates Firmware management is simplified by assigning firmware-compliance policies to managed devices. When you create and assign a compliance policy to managed devices, Lenovo XClarity Administrator monitors changes to the inventory for those devices and flags any devices that are out of compliance. When a device is out of compliance, you can use Lenovo XClarity Administrator to apply and activate firmware updates for all devices in that device from a repository of firmware updates that you manage. Note: Refreshing the repository and downloading firmware updates requires an Internet connection. If Lenovo XClarity Administrator has no Internet connection, you can manually import firmware updates to the repository. For more information about updating firmware, see. Learn more: Lenovo XClarity Administrator: Bare metal to cluster Lenovo XClarity Administrator: Firmware updates Lenovo XClarity Administrator: Provisioning firmware security updates Operating-system deployment You can use Lenovo XClarity Administrator to manage a repository of operating-system images and to deploy operating-system images to up to 28 servers managed servers concurrently. For more information about deploying operating systems, see. Learn more: 2 Lenovo XClarity Administrator Python Toolkit Reference

9 Lenovo XClarity Administrator: Bare metal to cluster Lenovo XClarity Administrator: Operating-system deployment User management Lenovo XClarity Administrator provides a centralized authentication server to create and manage user accounts and to manage and authenticate user credentials. The authentication server is created automatically when you start the management server for the first time. The user accounts that you create for Lenovo XClarity Administrator can also be used to log in to managed chassis and servers in managed-authentication mode. For more information about users, see. Lenovo XClarity Administrator supports three types of authentication servers: Local authentication server. By default, Lenovo XClarity Administrator is configured to use the local authentication server that resides on the management node. External LDAP server. Currently, only Microsoft Active Directory is supported. This server must reside on an outboard Microsoft Windows server that is connected to the management network. When an external LDAP server is used, the local authentication server is disabled. External SAML 2.0 identity provider. Currently, only Microsoft Active Directory Federation Services (AD FS) is supported. In addition to entering a user name and password, multi-factor authentication can be set up to enable additional security by requiring a PIN code, reading smart card, and client certificate. For more information about authentication types, see. When you create a user account, you assign a predefined or customized role group to the user account to control the level of access for that user. For more information about role groups, see. Lenovo XClarity Administrator includes an audit log that provides a historical record of user actions, such as logging on, creating new users, or changing user passwords. For more information about the audit log, see. Device authentication Lenovo XClarity Administrator uses the following methods for authenticating with managed chassis and servers. Managed authentication. When managed authentication is enabled, the user accounts that you create in Lenovo XClarity Administrator are used to authenticate managed chassis and servers. For more information about users, see. Local authentication. When managed authentication is disabled, the stored credentials that are defined in Lenovo XClarity Administrator are used to authenticate managed servers. The stored credentials must correspond to an active user account on the device or in Active Directory. For more information about stored credentials, see. Security If your environment must comply with NIST SP A standards, Lenovo XClarity Administrator can help you achieve a fully compliant environment. Lenovo XClarity Administrator supports self-signed SSL certificates (which are issued by an internal certificate authority) and external SSL certificates (which are issued by a private or commercial CA). Firewalls on chassis and servers can be configured to accept incoming requests from only Lenovo XClarity Administrator. For more information about security, see. Chapter 1. Lenovo XClarity Administrator Overview 3

10 Service and support Lenovo XClarity Administrator can be set up to collect and send diagnostic files automatically to your preferred service provider when certain serviceable events occur in Lenovo XClarity Administrator and the managed devices. You can choose to send diagnostic files to Lenovo Support using Call Home or to another service provider using SFTP. You can also manually collect diagnostic files, open a problem record, and send diagnostic files to the Lenovo Support Center. Learn more: Lenovo XClarity Administrator: Service and support Task automation using scripts Lenovo XClarity Administrator can be integrated into external, higher-level management and automation platforms through open REST application programming interfaces (APIs). Using the REST APIs, Lenovo XClarity Administrator can easily integrate with your existing management infrastructure. The PowerShell toolkit provides a library of cmdlets to automate provisioning and resource management from a Microsoft PowerShell session. The Python toolkit provides a Python-based library of commands and APIs to automate provisioning and resource management from an OpenStack environment, such as Ansible or Puppet. Both of these toolkits provide an interface to Lenovo XClarity Administrator REST APIs to automate functions such as: Logging in to Lenovo XClarity Administrator Managing and unmanaging chassis, servers, storage devices, and top-of-rack switches (devices) Collecting and viewing inventory data for devices and components Deploying an operating-system image to one or more servers Configuring servers through the use of Configuration Patterns Applying firmware updates to devices Integration with other managed software Lenovo XClarity Integrator modules integrate Lenovo XClarity Administrator with third-party management software to provide discovery, monitoring, configuration, and management functions to reduce the cost and complexity of routine system administration for supported devices. For more information about Lenovo XClarity Integrator, see the following documents: Lenovo XClarity Integrator for Microsoft System Center Lenovo XClarity Integrator for VMware vcenter Lenovo XClarity Integrator for Nutanix Prism For additional considerations, see. Learn more: Lenovo XClarity Integrator for Microsoft System Center overview Lenovo XClarity Integrator for VMware vcenter Documentation The Lenovo XClarity Administrator documentation is updated regularly online in English See the Lenovo XClarity Administrator online documentation for the most current information and procedures. The online documentation is available in the following languages: German (de) English (en) Spanish (es) French (fr) Italian (it) Japanese (ja) Korean (ko) 4 Lenovo XClarity Administrator Python Toolkit Reference

11 Brazilian Portuguese (pt_br) Russian (ru) Thai (th) Simplified Chinese (zh_cn) Traditional Chinese (zh_tw) You can change the language of the online documentation in the following ways: Change the language setting in your web browser Append?lang=<language_code> to the end of URL, for example, to display the online documentation in Simplified Chinese: Chapter 1. Lenovo XClarity Administrator Overview 5

12 6 Lenovo XClarity Administrator Python Toolkit Reference

13 Chapter 2. Python (PyLXCA) toolkit The PyLXCA toolkit provides a Python-based library of commands and APIs to automate provisioning and resource management from an OpenStack environment, such as Ansible. The PyLXCA toolkit provides an interface to Lenovo XClarity Administrator REST APIs to automate functions such as: Logging in to Lenovo XClarity Administrator Managing and unmanaging chassis, servers, storage devices, and top-of-rack switches (devices) Viewing inventory data for devices and components Deploying an operating-system image to one or more servers Configuring servers through the use of Configuration Patterns Applying firmware updates to devices Copyright Lenovo 2016,

14 8 Lenovo XClarity Administrator Python Toolkit Reference

15 Chapter 3. Installing the Python (PyLXCA) toolkit To use the PyLXCA commands and APIs, you must install the Lenovo XClarity Administrator Python Client Toolkit (PyLXCA) in Python. Before you begin Python (including the request and logging modules) is required to use to the PyLXCA toolkit. Ensure that the following requirements are met. For more information about Python, see the Python website. Python v2.7.x (Later versions have not been tested.) Python requests v2.7.0 or later (Install using the following command: pip install requests upgrade) Procedure To install the PyLXCA, run the following command: pip install pylxca To build and install from source, download the PyLXCA source code from Python LXCA Client (PyLXCA) Toolkit website, and run the following command from the source root directory: python setup.py install What to do next For information about using the PyLXCA commands, see Chapter 4 Using the Python (PyLXCA) toolkit on page 11. You can display the current version of PyLXCA from the python prompt, for example: $ python Python (default, Sep , 14:46:04) [GCC 4.8.4] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import pylxca >>> print pylxca. version 1.0 Copyright Lenovo 2016,

16 10 Lenovo XClarity Administrator Python Toolkit Reference

17 Chapter 4. Using the Python (PyLXCA) toolkit You can use the Lenovo XClarity Administrator Python (PyLXCA) toolkit from the Python shell, interactive shell, or as a Python script. Python shell You can run any of the PyLXCA commands from the Python shell. To start the Python shell, run the lxca_shell command. When you are in the Python shell, the prompt changes to PyLXCA >>. joe@joe_vm:~# lxca_shell Welcome to LXCA Command Shell Type "help" at any time for a list of commands. Use "lxca_shell --api" to enable Interactive Python LXCA Shell PyLXCA >> connect --url --user USER1 -noverify true For information about each PyLXCA command, see Chapter 5 PyLXCA commands reference on page 15. Interactive shell When you use the interactive Python Lenovo XClarity Administrator shell, you can use built-in Python functions in addition to PyLXCA commands. To start the interactive shell, run the pyshell --api command. When you are in the interactive shell, the prompt changes to >>>. joe@joe_vm:~#lxca_shell --api Interactive Python Shell for Lenovo XClarity Administrator Type "dir()" or "help(lxca command object)" for more information. >>> >>> con1 = connect(" To get detailed help for the PyLXCA functions, use the python help(command_name) function. For example, help(connect) returns help for the connect function. Python scripts Just like the Python shell, when you create the Python scripts, you can use built-in Python functions in addition to PyLXCA APIs Note: At the beginning of your script, you must import PyLXCA and connect to the Lenovo XClarity Administrator instance, for example: #!/usr/bin/env python from pylxca. import * con1 = connect(" Python (PyLXCA) toolkit examples A sample script is available to help you to begin using the PyLXCA command-line interface (CLI) to manage devices quickly. The sample script is located in the following directory: <python_install>\lib\site-packages\pylxca\test Copyright Lenovo 2016,

18 The following script is included in the directory: pylxca_unittest Retrieves inventory for managed devices of each supported type. Creating custom views A view (or filter) determines what data is returned by a PyLXCA inventory command. The default views for each command are defined in the <python_install_dir>/site-packages/pylxca-1.0-py2.7.egg/pylxca/pylxca_ cmd/lxca_filters.xml file. You can add your own custom views. In the lxca_filters.xml file, all default and custom views are included under the <filters> tag. You can also add custom views under this tag for any command that returns inventory data. In the following example, there is a filter for the chassis command named default. This is the default view that is used if the --view parameter is not specified. The following example also has a filter for the cmm command named location_ view To use this view, specify --view location_view when you run the command. <filters> <chassis name="default">...</chassis> <chassis name="health_view">...</chassis> <cmm name="location_view">...</cmm> </filters> Under each command tag (such as <chassis>) are the fields that you want returned for that view. You can choose to return any response-body field that the inventory REST API supports for the device type. In the following example, Name and ChassisLocation are the labels that are returned by the chassis command, and name and location are the names of the response-body fields in the request. If the field is an object, you must specify type="object in the tag and then list the fields in the object that you want to return under the tag. <filters> <chassis name="location_view"> <Name>name</Name> <ChassisLocation name="location" type="object"> <Rack>rack</Rack> <Room>room</Room> </Chassis_Location> <Contact>contact</Contact> <Type>type</Type> <IPAddresses>ipAddresses</IPAddresses> <HostName>hostname</HostHame> <UUID>uuid</UUID> </chassis> </filters> If you do not specify type= object for objects and arrays of objects, the returned data is null. The response-body field names are case-sensitive. The following example is returned if you run the chassis command using the location_view filter that is defined previously: Name: SN#Y031BG19H006 ChassisLocation: Rack: [] Room: [] Contact: None Type: Chassis IPAddresses: [u' ', u'fe80::5ef3:fcff:fe25:e1dd', u'fd55:faaf:e1ab:2021:5ef3:fcff:fe25:e1dd'] HostName: SN#Y031BG19H006 UUID: 05d1bb734a054b0eaec7b19dcc50b Lenovo XClarity Administrator Python Toolkit Reference

19 diagram conventions To understand the command descriptions, Review the conventions used in syntax diagrams. The syntax diagram consists of options and arguments. Options consist of a dash and single letter (for example, -v) or two dashes and multiple letters (for example, --view). Options can be followed by one or more arguments (for example, as illustrated in [-v <filter>]). Consider these conventions when reading syntax diagrams: Options that are preceded by one dash (-) are case-sensitive. Options that are preceded by two dashes (--) must be specified in their entirety. These options are not case-sensitive. The names of arguments that require substitution by actual values are italicized and enclosed in greaterthan and less-than symbols (< >). Options that are enclosed in brackets ([]) are optional. Do not include these brackets in the command. Options that are enclosed in braces ({}) are required. Do not include these braces in the command. Options that are not enclosed in either brackets or braces are required. The pipe ( ) character signifies that you choose one option or the other. For example, [a b] indicates that you can choose either a or b, but not both. Similarly, {a b} indicates that you must choose either a or b. An ellipsis (...) signifies that you can repeat the operand and option argument on the command line. Chapter 4. Using the Python (PyLXCA) toolkit 13

20 14 Lenovo XClarity Administrator Python Toolkit Reference

21 Chapter 5. PyLXCA commands reference These are the commands that are provided by the Lenovo XClarity Administrator PyLXCA toolkit. Component Command Description General connect on page 20 This command creates a connection (logs in) to the Lenovo XClarity Administrator server that can be used by other commands. Dpycli_refevice management disconnect on page 21 exit help on page 24 ostream on page 29 discover on page 21 manage on page 26 This command ends the connection to (logs out of) the Lenovo XClarity Administrator server. This command exits the PyLXCA interactive shell. This command displays a list of all available commands and a short description of each. This command sets the output-stream of the PyLXCA interactive shell. This command discovers manageable devices using SLP discovery. This command manages a discovered device. unmanage on page 32 This command unmanages a managed device. Inventory chassis on page 16 This command retrieves inventory data about all managed or unmanaged chassis, or a specific chassis. Server configuration cmms on page 17 fanmuxes on page 22 fans on page 23 nodes on page 28 powersupplies on page 30 scalablesystem on page 30 switches on page 31 configpatterns on page 18 configprofiles on page 19 This command retrieves inventory data about all CMMs in managed chassis, all CMMs in a specific chassis, or a specific CMM. This command retrieves inventory data about all fan logic modules (called fan muxes) in managed chassis, all fan muxes in a specific chassis, or a specific fan mux. This command retrieves inventory data about all fans in managed devices, all fans in a specific chassis, or a specific fan. This command retrieves inventory data about all managed or unmanaged servers and Flex System storage devices, all servers (compute nodes) or Flex System storage devices in a specific chassis, or a specific server or Flex System storage device. This command retrieves inventory data about all power supplies in managed devices, all power supplies in a specific chassis, or a specific power supply. This command retrieves inventory data about all managed or unmanaged scalable complexes, all Flex System scalable complexes, all System x and ThinkServer scalable complexes, or a specific scalable complex. This command retrieves inventory data about all managed Flex System and RackSwitch switches, all Flex System switches in a specific chassis, or a specific Flex System or RackSwitch switch. This command retrieves information about one or more server patterns or deploys a server pattern and associated category patterns to a target server. This command retrieves information about one or more server profiles. Copyright Lenovo 2016,

22 Component Command Description Firmware updates User management Service and support configtargets on page 19 updatecomp on page 33 updatepolicy on page 35 updaterepo on page 36 users on page 38 ffdc on page 22 This command retrieves a list of deployable servers and server bays that are associated with the specified server pattern or profile. This command updates firmware on a specific device, and retrieves the status and progress of firmware updates and firmware repository. This command retrieves detailed information about firmware-compliance policies and assigns a compliance policy to a specific device.. This command retrieves information about firmware updates in the firmware-updates repository. This command retrieve information about all local Lenovo XClarity Administrator users or a specific local user.. This command collects and exports first failure data capture (FFDC) data for a specific managed device (CMM, server, storage device, or switch). Logs jobs on page 24 This command manages or retrieves information about one or more jobs. log on page 25 lxcalog on page 26 This command sets or retrieves the current log level for the PyLXCA toolkit. This command retrieves hardware and management-server events in the events log. chassis The chassis command retrieves inventory data about all managed or unmanaged chassis, or a specific chassis. chassis chassis [-s <management_status>] [-u <chassis_uuid>] [-v <filter>] Options Displays the syntax and brief usage information for this command. {-s --status} <management_status> Identifies the management status of the chassis to be returned. You can specify one of the following values: manage. Returns inventory data for all managed chassis. This is the default value. unmanaged. Returns inventory data for all discovered chassis that Lenovo XClarity Administrator does not manage. {-u --uuid} <node_uuid> Specifies the UUID of a chassis. If a UUID is not specified, this command returns inventory data for all managed chassis unless you also specify the -s unmanaged option. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). 16 Lenovo XClarity Administrator Python Toolkit Reference

23 Examples The following example returns inventory data for a specific chassis. chassis -u B E19AE3EF8BCD Related links connect on page 20 cmms on page 17 fans on page 23 fanmuxes on page 22 nodes on page 28 powersupplies on page 30 switches on page 31 cmms The cmms command retrieves inventory data about all CMMs in managed chassis, all CMMs in a specific chassis, or a specific CMM. cmms cmms [-c <chassis_uuid> -u <cmm_uuid>] [-v <filter>] Options Displays the syntax and brief usage information for this command. {-c --chassis} <chassis_uuid> Specifies the UUID of a managed chassis. This command returns inventory data for all CMMs in that chassis. {-u --uuid} <cmm_uuid> Specifies the UUID of a CMM. If a UUID is not specified, this command returns inventory data for all CMMs in all managed chassis. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns inventory data for all CMMs in managed chassis. cmms Related links connect on page 20 chassis on page 16 Chapter 5. PyLXCA commands reference 17

24 configpatterns The configpatterns command retrieves information about one or more server patterns or deploys a server pattern and associated category patterns to a target server. configpatterns configpatterns configpatterns [-i <pattern_id>] [-v <filter>] -i <pattern_id> -r <activation_time> -e <server UUIDs> -t <server_type> Options Displays the syntax and brief usage information for this command. {-i --id} <pattern_id> Specifies the ID of the server pattern. If an ID is not specified, all server patterns are returned. {-e --endpoint} <server_uuid> Specifies the UUIDs of one or more target servers. If a target is an empty bay, specify the location ID; otherwise, specify the server UUID. {-r --restart} <activation_time> Identifies when to activate the configurations. This can be one of the following values: defer. Activate management-controller settings but do not restart the server. UEFI and server settings are activated after the next restart of the server. immediate. Activate all settings and restart the server immediately. pending. Generate a profile for the server with the settings for review, but do not activate settings on the server. To activate the settings, you must manually activate the server profile and restart the server. {-t --type} <server_type> Type of the server. This can be one of the following values: node. Flex System compute node rack. Stand-alone rack server tower. Stand-alone tower server {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns information about all server patterns. connect --url --user ADMIN -noverify configpatterns The following example returns information about a specific server pattern. connect --url --user ADMIN -noverify configpatterns -i 48 The following example deploys a server pattern to two rack servers and immediately activates the pattern on the servers. 18 Lenovo XClarity Administrator Python Toolkit Reference

25 configpatterns -i 48 -r immediate -t rack -e 1B54B9AEFCE04D5E820C0B6310D03590,1B54B9AEFCE04D5E820C0B6310D03590 Related links connect on page 20 configprofiles on page 19 configtargets on page 19 configprofiles The configprofiles command retrieves information about one or more server profiles. configprofiles configprofiles [-i <profile_id>] -v <filter> Options Displays the syntax and brief usage information for this command. {-i --id} <profile_id> Specifies the ID of the server profile. If an ID is not specified, all server profiles are returned. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns information about a specific server profile. configprofiles -i 121 -v id Related links connect on page 20 configpatterns on page 18 configtargets on page 19 configtargets The configtargets command retrieves a list of deployable servers and server bays that are associated with the specified server pattern or profile. configtargets configtargets [-i [<pattern_id> <profile_id>] [-v <filter>] Options Displays the syntax and brief usage information for this command. Chapter 5. PyLXCA commands reference 19

26 {-i --id} [<pattern_id> <profile_id>] Specifies the ID of the configuration pattern or server profile. If an ID is not specified, data is returned for all server patterns and profiles. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example retrieves the list of deployable target devices that are associated with a specific server pattern. configtargets -i 48 Related links connect on page 20 configprofiles on page 19 configpatterns on page 18 connect The connect command creates a connection (logs in) to the Lenovo XClarity Administrator server that can be used by other commands. Use the disconnect on page 21 command to log out of the Lenovo XClarity Administrator server. connect connect -l <HTTPS_addresss> -u <user_id> [ noverify] Options Displays the syntax and brief usage information for this command. {-l --url} <HTTPS_addresss> Specifies the HTTPS address (IP address or hostname) for the Lenovo XClarity Administrator server (for example, {-u --user} <user_id> Specifies the user ID for logging in to the Lenovo XClarity Administrator server. You are prompted to input the password. Password is entered in a non-verbose mode. --noverify Does not verify the Lenovo XClarity Administrator server certificate. If this option is not specified, the server certificate is verified when the connection is made. Examples The following example connects to the Lenovo XClarity Administrator server using the HTTPS address and user ID USER1. connect --url --user USER1 --noverify 20 Lenovo XClarity Administrator Python Toolkit Reference

27 Related links disconnect on page 21 disconnect The disconnect command ends the connection to (logs out of) the Lenovo XClarity Administrator server. Use the connect on page 20 command to log in to the Lenovo XClarity Administrator server. disconnect disconnect Options Displays the syntax and brief usage information for this command. Examples The following example disconnects from the Lenovo XClarity Administrator server. disconnect Related links connect on page 20 discover The discover command discovers manageable devices using SLP discovery. This command starts a job to perform the discover action. If successful, the job ID is returned. You can use the job ID in the jobs -i on page 24 or discover -j on page 21 command to determine the status of the job. discover discover discover -i <IP_address> -j <job_id> Options Displays the syntax and brief usage information for this command. {-i --ip} <IP_address> Specifies the IP addresses of one or more devices to be discovered. Separate each IP address using a comma. {-j --job} Specifies the job ID. If specified, this command returns status information about the specified job. Examples The following example discovers devices with the specified IP addresses. Chapter 5. PyLXCA commands reference 21

28 connect --url --user ADMIN discover -i , The following example retrieves status information about the specified discovery job. discover -j 22 Related links connect on page 20 manage on page 26 unmanage on page 32 ffdc The ffdc command collects and exports first failure data capture (FFDC) data for a specific managed device (CMM, server, storage device, or switch). ffdc ffdc [-u <device_uuid>] Options Displays the syntax and brief usage information for this command. {-u --uuid} <device_uuid> Specifies the UUID of a device. If a UUID is not specified, this command returns FFDC data for all devices. Examples The following example returns FFDC data for a specific device. ffdc -u B E19AE3EF8BCD Related links connect on page 20 fanmuxes The fanmuxes command retrieves inventory data about all fan logic modules (called fan muxes) in managed chassis, all fan muxes in a specific chassis, or a specific fan mux. fanmuxes fanmuxes [-u <fan_mux_uuid>] [-c <chassis_uuid>] [-v <filter>] Options Displays the syntax and brief usage information for this command. {-c --chassis} <chassis_uuid> 22 Lenovo XClarity Administrator Python Toolkit Reference

29 Specifies the UUID of a managed chassis. This command returns inventory data for all fan muxes in the chassis. {-u --uuid} <fan_mux_uuid> Specifies the UUID of a fan mux. If a UUID is not specified, this command returns inventory data for all fan muxes. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns inventory data for all fan muxes in specific chassis. fanmuxes -c B E19AE3EF8BCD Related links connect on page 20 chassis on page 16 fans The fans command retrieves inventory data about all fans in managed devices, all fans in a specific chassis, or a specific fan. fans fans [-u <fan_uuid>] [-c <chassis_uuid>] [-v <filter>] Options Displays the syntax and brief usage information for this command. {-c --chassis} <chassis_uuid> Specifies the UUID of a managed chassis. This command returns inventory data for all fans in the chassis. {-u --uuid} <fan_uuid> Specifies the UUID of a fan. If a UUID is not specified, this command returns inventory data for all fans in managed devices. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns inventory data for all fans in the specified chassis. fans -c B E19AE3EF8BCD Chapter 5. PyLXCA commands reference 23

30 Related links connect on page 20 chassis on page 16 help The help command displays a list of all available commands and a short description of each. help Options None Examples The following example retrieves help for all commands. help jobs The jobs command manages or retrieves information about one or more jobs. jobs jobs jobs jobs [-i <job_id>] [-u <UUID>] [-s <job_state>] -c <job_id> -d <job_id> Options If no parameters are specified, this command retrieves information about all jobs. Displays the syntax and brief usage information for this command. {-i --id} <job_id> The ID of the job. {-u --uuid} <UUID> The UUID of the device. This command retrieves information about all jobs that are associated with the specified device. {-s --state} <job_state> The job state. You can specify one of the following values: Complete Cancelled CancelledWithErrors CompleteWithErrors CompleteWithWarnings Interrupted Pending Running RunningWithErrors 24 Lenovo XClarity Administrator Python Toolkit Reference

31 RunningWithWarnings Skipped StoppedWithWarnings Unknown Uploading Validating {-c --cancel} <job_id> Cancels the job with the specified job ID. Note: If you specify this parameter, you must also specify the i parameter. {-d --delete} <job_id> Deletes the job with the specified job ID. Note: If you specify this parameter, you must also specify the i parameter. Examples The following example retrieves information about all jobs that are associated with a specific device. connect --url --user ADMIN -noverify jobs -u B E19AE3EF8BCD The following example deletes a specific job. connect --url --user ADMIN -noverify jobs -d 2 The following example cancels a specific job. jobs -c 2 Related links connect on page 20 log The log command sets or retrieves the current log level for the PyLXCA toolkit. log log [-l <level>] Options Displays the syntax and brief usage information for this command. {-l --lvl} <level> Sets the log level. You can specify one of the following values: DEBUG. Displays detailed information, typically of interest only when diagnosing problems. INFO. Displays information that confirms that things are working as expected. WARNING. Displays information that indicates that something unexpected happened or that a problem might occur soon. ERROR. Displays information about serious problems, indicating that the software cannot perform a function. Chapter 5. PyLXCA commands reference 25

32 CRITICAL. Displays information about serious errors, indicating that the program itself might be unable to continue running. When you choose a severity level, messages at that severity level and all lower severity levels are returned. For example, if you specify WARNING, all WARNING, INFO, and DEBUG messages are returned. Examples The following example retrieves the current log level. log The following example sets the current log level to warning and lower. connect --url --user ADMIN -noverify log -l WARNING Related links connect on page 20 lxcalog on page 26 lxcalog The lxcalog command retrieves hardware and management-server events in the events log. lxcalog lxcalog [-f <event_filter>] Options Displays the syntax and brief usage information for this command. {-f --filter} <event_filter> Returns only the events that apply to the specified filters (see Filtering events in the Lenovo XClarity Administrator online documentation). If you do not specify a filter, all events are returned. Examples The following example returns hardware and management-server events in the events log. lxcalog Related links connect on page 20 log on page 25 manage The manage command manages a discovered device. The devices must be discovered using the discover on page 21 command before running this command 26 Lenovo XClarity Administrator Python Toolkit Reference

33 This command starts a job to perform the management action. If successful, the job ID is returned. You can use the job ID in the jobs on page 24 command or the manage j command to determine the status of the job. manage manage -e <device_uuid> -i <IP_address> [-m <management_port_properties>] [-t <device_type> -p <device_password> -r <recovery password> -u <device_user_id> [-f <boolean> manage -j <job_id> [-v <filter>] Notes: The following options for managing a device will be deprecated in a future release. Use -i <IP_ address> instead. {-e --epuuid} <device_uuid> [{-m --mp} <management_port_properties>] [{-t --type} <device_type>] Options Displays the syntax and brief usage information for this command. {-e --epuuid} <device_uuid> Specifies the UUID of the device to be managed. {-f --force} <boolean> If specified, the devices are managed by this Lenovo XClarity Administrator server even if they are already managed by another Lenovo XClarity Administrator server. A device can be managed by only one Lenovo XClarity Administrator server at a time. Management by multiple managers is not supported. {-i --ip} <IP_address> Specifies the IP address of the device to be managed. {-j --job} <job_id> Specifies the job ID. If specified, this command returns status information about the specified job. {-m --mp} <management_port_properties> Specifies a set of management-port properties for one or more devices. Each property in the set is separated by a comma, and each set is separated by a colon. The properties include: Protocol that is running on the port (for example, http, https, or snmpv3) Port number Boolean flag indicating port enablement For example: http,80,false;snmpv3,161,true {-p --pw} <device_password> Specifies the password for the device user account. {-r --rpw} <recovery password> Specifies the recovery-id password for the device. When you manage a chassis, the CMM is configured to authenticate users with Lenovo XClarity Administrator. Local CMM user accounts are no longer valid. If there are issues with Lenovo XClarity Chapter 5. PyLXCA commands reference 27

34 Administrator, you can use the RECOVERY_ID to access the CMM directly. Ensure that you write down the password that you specify and store it in a secure location. When you manage a Converged, NeXtScale, or System x server, the baseboard management controller is configured to authenticate users with the Lenovo XClarity Administrator server. Local managementcontroller user accounts are no longer valid. If there are issues with the Lenovo XClarity Administrator server, you can use the RECOVERY_ID to access the management controller directly. Ensure that you write down the password that you specify and store it in a secure location. {-t --type} <device_type> Specifies the type of device to be managed. You can specify one of the following values: Chassis ThinkServer Storage Rackswitch Rack-Tower {-u --user} <device_user_id> Specifies a user account with supervisor privileges for the device. If the device to be managed is a chassis, specify a user account for the CMM in that chassis. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example manages a device. manage -i m false,80,http t 48331a223bf34fba90732b379b837b9c -u USERID -p xxxxxxxx -r xxxxxxxx The following example returns information about a management job. connect --url --user ADMIN -noverify manage -j 4 Related links connect on page 20 discover on page 21 unmanage on page 32 nodes The nodes command retrieves inventory data about all managed or unmanaged servers and Flex System storage devices, all servers (compute nodes) or Flex System storage devices in a specific chassis, or a specific server or Flex System storage device. nodes nodes [-u <node_uuid>] [-s <managemnt_status>] [-c <chassis_uuid>] [-v <filter>] Parameters 28 Lenovo XClarity Administrator Python Toolkit Reference

35 Displays the syntax and brief usage information for this command. {-c --chassis} <chassis_uuid> Specifies the UUID of a managed chassis. This command returns inventory data for all compute nodes in the chassis. {-s --status} <managemnt_status> Identifies the management status of servers. You can specify one of the following values: manage. Returns information for all managed servers. unmanaged. Returns information for all discovered servers that are not managed by Lenovo XClarity Administrator. {-u --uuid} <node_uuid> Specifies the UUID of a server. If a UUID is not specified, this command returns inventory data for all managed servers unless you also specify the -s unmanaged option. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns inventory data for all managed compute nodes in a specific chassis. nodes -c B E19AE3EF8BCD Related links connect on page 20 chassis on page 16 ostream The ostream command sets the output-stream of the PyLXCA interactive shell to standard output (stdout), a file, or both. ostream ostream -l <output_stream> Options Displays the syntax and brief usage information for this command. {-l --lvl} <output_stream> Specifies the output stream. You can specify one of the following values: 0. Quiet. 1. Console. 2. File. 3. Console and File. The output-stream file is specified in the <install_dir>\lxca_console.out file Chapter 5. PyLXCA commands reference 29

36 You can retrieve the list of values by entering the -l? option. Examples The following example sets the output stream to a file: ostream -1 2 Related links connect on page 20 powersupplies The powersupplies command retrieves inventory data about all power supplies in managed devices, all power supplies in a specific chassis, or a specific power supply. powersupplies powersupplies [-u <power_supply_uuid>] [-c <chassis_uuid>] [-v <filter>] Options Displays the syntax and brief usage information for this command. {-c --chassis} <chassis_uuid> Specifies the UUID of a managed chassis. This command returns inventory data for all power supplies in the chassis. {-u --uuid} <power_supply_uuid> Specifies the UUID of a power supply. If a UUID is not specified, this command returns inventory data for all power supplies in managed devices. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns inventory data for all fans in managed devices. powersupplies Related links connect on page 20 chassis on page 16 scalablesystem The scalablesystem command retrieves inventory data about all managed or unmanaged scalable complexes, all Flex System scalable complexes, all System x and ThinkServer scalable complexes, or a specific scalable complex. scalablesystem 30 Lenovo XClarity Administrator Python Toolkit Reference

37 scalablesystem [-i <system_uuid>] [-t <node_type>] [-v <filter>] Options Displays the syntax and brief usage information for this command. {-i --id} <system_uuid> Specifies the UUID of a scalable complex. If a UUID is not specified, this command returns inventory data for all managed scalable complexes unless you also specify the -s unmanaged parameter or -t parameter. {-t --type} <node_type> Specifies the type of scalable complex. You can specify one of the following values: flex. Returns information for one or more Flex System scalable complexes. rackserver. Returns information for one or more System x or ThinkServer scalable complexes. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns inventory data for all managed scalable complexes in a rack. scalablesystem -t rackserver Related links connect on page 20 nodes on page 28 switches The switches command retrieves inventory data about all managed Flex System and RackSwitch switches, all Flex System switches in a specific chassis, or a specific Flex System or RackSwitch switch. switches switches switches [-u <switch_uuid>] [-c <chassis_uuid>] [-v <filter>] [-u <switch_uuid>] --ports <port_name> [--action <action>] Options Displays the syntax and brief usage information for this command. {--action} <action> Specifies the action to take on the specified port. This can be one or none of the following values: enable. Enable the specified port. disable. Disable the specified port If no action is specified, this command displays port information for the specified switch. Chapter 5. PyLXCA commands reference 31

38 {-c --chassis} <chassis_uuid> Specifies the UUID of a managed chassis. This command returns inventory data for all Flex System switches in the chassis. {--ports} <port_name> Specifies the ports to be modified. To obtain the port name, use this command without the ports option to display information about the specified switch.. {-u --uuid} <switch_uuid> Specifies the UUID of a switch. If a UUID is not specified, this command returns inventory data for all managed switches unless you also specify the -s unmanaged option. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns inventory data for all Flex System switches in the specified chassis. switches -c B E19AE3EF8BCD The following example enables a port on the specified switch.. switches -u A E19AE3EF8BCF ports Ethernet1/1 --action enable Related links connect on page 20 chassis on page 16 unmanage The unmanage command unmanages a managed device. This command starts a job to perform the unmanagement action. If successful, the job ID is returned. You can use the job ID in the jobs on page 24 command or the unmanager j command to determine the status of the job. unmanage unmanage unmanage -e <device_properties> [--force <Boolean>] -j <job_id> [-v <filter>] Options Displays the syntax and brief usage information for this command. {-e --ep} <device_properties> Specifies a set of properties for one or more devices to be unmanaged. Each set is separated by a comma, and each property in the set is separated by a semicolon. The properties include: 32 Lenovo XClarity Administrator Python Toolkit Reference

39 One or more IP addresses, separated by a hash sign (#). The UUID of the device The type of device to be unmanaged. You can specify one of the following values: Chassis. Lenovo ThinkServer Lenovo Storage Nimble. Nimble storage device Rackswitch Rack-Tower Server. Converged, NeXtScale, System x or ThinkSystem server For example: # ;F6F5A2630C244FDD9DE C55480;Chassis, ;63E29269BB634AB9A610D6F8FCE2B28F;Rack-Tower Server {--force} <Boolean> Forces the unmanagement of a device. You can specify one of the following values: true false {-j --job} <job_id> Specifies the job ID. If specified, this command returns status information about the specified job {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example unmanages a device with a specific IP address. unmanage e ;63E29269BB634AB9A610D6F8FCE2B28F;Rack-Tower Server Related links connect on page 20 discover on page 21 manage on page 26 updatecomp The updatecomp command updates firmware on a specific device, and retrieves the status and progress of firmware updates and firmware repository. updatecomp updatecomp updatecomp updatecomp [-q <data_type>] [-v <filter>] [-a <action>] [-m <activate_mode>] [-c <CMMs>] [-s <servers>] [-w <switches>] [-t <storage_systems>] -a power [-c <cmms>] [-s <servers>] [-w <switches>] Note: You must specify one or more of the following parameters: c, s, t, and w. Chapter 5. PyLXCA commands reference 33

40 Options Displays the syntax and brief usage information for this command. { a --action} <action> Specifies the action to take. This can be one of the following values apply. Applies the associated firmware to the specified device. This is the default value. The following set of properties must be specified for each device. Each property is separated by a semicolon, and each set of properties is separated by a comma. UUID of the storage system Fix (firmware-update) ID of the target package to be applied to the component. Component name For example: 8BFBADCC33CB11E499F740F2E ;lnvgy_fw_storage_1.1.1;Controller A cancelapply. Cancels the firmware update request on the specified device The following set of properties must be specified for each device. Each property is separated by a semicolon, and each set of properties is separated by a comma. UUID of the storage system Fix (firmware-update) ID of the target package to be applied to the component. Component name For example: 8BFBADCC33CB11E499F740F2E ;lnvgy_fw_storage_1.1.1;Controller A power. Performs a power operation on the specified device. The following set of properties must be specified for each device. Each property is separated by a semicolon, and each set of properties is separated by a comma. UUID of the device The power state. This can be one of the following values, depending on the type of device: CMM: reset Server: poweron, poweroff, powercyclesoft, powercyclesoftgraceful, poweroffhardgraceful Switch: poweron, poweroff, powercyclesoft Storage: poweron, poweroff, powercyclesoft For example: 8BFBADCC33CB11E499F740F2E ;powerOn,9AEDACCC56SD23F346A852D2D ;powerOn {-c --cmm} <CMMs> Specifies a set of properties for one or more CMMs. {-m --mode} Indicates when to activate the update. This can be one of the following values. immediate. Uses Immediate Activation mode when applying firmware updates to the selected devices. This is the default value. delayed. Uses Delayed Activation mode when applying firmware updates to the selected devices. {-q --query} <data_type> The data to return. This can be one of the following values. components. Returns a list of devices and components that can be updated status. Returns the status of firmware updates that are in progress. This is the default value {-s --server} <servers> Specifies a set of properties for one or more servers. {-t --storage} <storage_systems> Specifies a set of properties for one or more storage devices. 34 Lenovo XClarity Administrator Python Toolkit Reference

41 {-w --switch} <switches> Specifies a set of properties for one or more switches. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns the status and progress of firmware updates and firmware-updates repository. updatecomp -q status The following example applies a firmware update on a storage device and immediate activates the update. updatecomp -a immediate -t 8BFBADCC33CB11E499F740F2E ; lnvgy_fw_storage_1.1.1;controller A The following example powers off a server and a storage system. updatecomp -a power s 9AEDACCC56SD23F346A852D2D ;powerOff t 8BFBADCC33CB11E499F740F2E ;powerOff Related links updatepolicy on page 35 updaterepo on page 36 updatepolicy The updatepolicy command retrieves detailed information about firmware-compliance policies and assigns a compliance policy to a specific device.. This command starts a job to perform the update-policy action. If successful, the job ID is returned. You can use the job ID in the jobs on page 24 command to determine the status of the job. updatepolicy updatepolicy updatepolicy [-i <information_type>] [-v <filter>] -p <policies> -u <device_uuid> -t <device_type> updatepolicy -j <job_id> Options Displays the syntax and brief usage information for this command. {-i --info} <information_type> Specifies the type of information to return. This can be one of the following values: FIRMWARE. Returns information about firmware that is applicable to each managed device RESULTS. Returns persisted compare result for servers to which a compliance policy is assigned {-j --job} <job_id> Specifies the policy job ID for the assign compliance-policy operation. If specified, this command returns status information about the specified job. {-p --policy} <policies> Chapter 5. PyLXCA commands reference 35

42 Specifies the name of the compliance policy to be assigned. {-t --type} <device_type> Specifies the UUID of the device to which you want to assign the compliance policy. CMM. Chassis Management Module IOSwitch. Flex switch RACKSWITCH. RackSwitch switch STORAGE. Lenovo Storage system SERVER. Compute node or rack server {-u --uuid} <device_uuid> Specifies the UUID of the device to which you want to assign the compliance policy. {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Examples The following example returns information about all compliance policies. updatepolicy The following example assigns a compliance policy to a server. updatepolicy p policy_1 t SERVER u 8BFBADCC33CB11E499F740F2E Related links updatecomp on page 33 updaterepo on page 36 updaterepo The updaterepo command retrieves information about firmware updates in the firmware-updates repository. updaterepo updaterepo -a {acquire delete} f <update_id> updaterepo -a read updaterepo -a refresh updaterepo -k <update_type> [-v <filter>] Options Displays the syntax and brief usage information for this command. {-a --action} <action> Specifies the action to take. This can be one of the following values. acquire. Uploads the specified firmware updates from the Lenovo Support website, and stores the updates in the firmware-updates repository. 36 Lenovo XClarity Administrator Python Toolkit Reference

43 delete. Deletes the specified firmware updates from the firmware-updates repository. read. Reloads the repository files by clearing the information in cache and retrieving the list of firmware-update file from the repository. refresh. Retrieves information about the latest available firmware updates from the Lenovo Support website. { f --fixids} <update_ids> Specifies a list of firmware-update IDs, separated by a comma. You can find a list of IDs by using updaterepro k updates. {-k --keys} <update_type> Returns specific information about the firmware update. You can specify one of the following values. export. Returns the ZIP file that contain the firmware-compliance policies. importdir. Returns the import directory for the repository. isupdating. Returns the whether the firmware repository is being updated. lastrefreshed. Returns the timestamp of the last repository refresh publickeys. Returns the supported signed keys size. Returns the repository size supportedmts. Returns a list of supported machine types updates. Returns information about all firmware updates updatesbymt. Returns information about firmware updates for the specified machine types updatesbymtbycomp. Returns the update component names for the specified machine types { m --mt} <machine_types> Specifies a list of machine types, separated by a comma. { s --scope} <scope> Specifies the scope of the operation. This can be one of the following values. all. Scopes information about firmware updates when the following options are specified. This is the default value. k updates. Returns information about all firmware updates. k updatesbymt..returns information about all firmware updates a refresh. Returns information about all versions of all firmware updates that are available for all supported devices. latest. Scopes information about firmware updates when the following options are specified. k updates. Returns information about only the most current firmware updates. k updatesbymt. Returns information about only the most current firmware updates a refresh. Returns information about the most current version of all firmware updates for all supported devices payloads. When a acquire is specified, uploads only firmware-update images. If not specified, uploads all package files (payload, change history, readme, and metadata files). { t --type} <update_types> Specifies the update type when a delete is specified. This can be one of the following values: all. Deletes selected update-package files (payload, change history, readme, and metadata files) payloads. Deletes only the selected payload (image) files {-v --view} <filter> Identifies the view to use for the returned data. If a filter is not specified, the default view is used. You can also create custom views (see Creating custom views on page 12). Chapter 5. PyLXCA commands reference 37

44 Examples The following example returns information about all firmware updates by machine type. updatepolicy k updatesbymt Related links connect on page 20 users The users command retrieve information about all local Lenovo XClarity Administrator users or a specific local user.. users users [-i <user_id>] Options Displays the syntax and brief usage information for this command. {-i --id} <user_id> Specifies the unique ID of the local user. If a user ID is not specified, information about all local users is retrieved. Examples The following example retrieves information about all local Lenovo XClarity Administrator users. users Related links connect on page Lenovo XClarity Administrator Python Toolkit Reference

45 Index C chassis discover 21 inventory 16 manage 26 unmanage 32 chassis command 16 cmms discover 21 inventory 17 manage 26 unmanage 32 cmms command 17 configpatterns command 18 configprofiles command 19 configtargets command 19 connect command 20 custom views 12 D disconnect command 21 discover command 21 discovering devices 21 E event log 26 F fan muxes discover 21 inventory 22 manage 26 unmanage 32 fanmuxes command 22 fans discover 21 inventory 23 manage 26 unmanage 32 fans command 23 features, Lenovo XClarity Administrator 1 ffdc command 22 FFDC data collecting 22 exporting 22 firmware, updating 33, Flex System switches, See switches H help command 24 I inventory chassis 16 cmms 17 fan muxes 22 J fans 23 Flex System switches 31 nodes 28 power supplies 30 RackSwitch switches 31 scalable complexes 30 servers 28 jobs command 24 jobs level 24 L Lenovo XClarity Administrator features 1 logging in 20 logging out 21 overview 1 log command 25 log level 25 logging in 20 logging out 21 lxcalog command 26 M manage command 26 managing devices 26 N nodes command 28 O ostream command 29 output stream level 29 overview, Lenovo XClarity Administrator 1 P power supplies discover 21 manage 26 unmanage 32 powersupplies inventory 30 powersupplies command 30 PyLXCA commands chassis 16 cmms 17 configpatterns 18 configprofiles 19 configtargets 19 connect 20 disconnect 21 discover 21, fanmuxes 22 Copyright Lenovo 2016,

46 R fans 23 ffdc 22 help 24 lxcalog 26 manage 26 nodes 28 ostream 29 powersupplies 30 scalablesystem 30 switches 31 unmanage 32 updatecomp 33 updatepolicy 35 updaterepo 36 users 38 RackSwitch switches, See switches S scalable complexes inventory 30 scalable systems discover 21 manage 26 unmanage 32 scalablesystem command 30 server patterns, deployable devices 19 server patterns, information about 18 server profiles, devices for 19 server profiles, information about 19 servers discover 21 inventory 28 manage 26 unmanage 32 switches discover 21 inventory 31 manage 26 unmanage 32 switches command 31 syntax diagram 13 U unmanage command 32 unmanaging devices 32 updatecomp command 33 updatepolicy command 35 updaterepo command 36 users 38 users command Lenovo XClarity Administrator Python Toolkit Reference

47

48