Uninstall tool serial 3.2.2

Override the currently selected type. Save a selected type to a file in JSON format. You can edit the values in the file, and then use the load command to upload the changes to the server. If no filename is supplied with the -f, --filename option, save looks for a file named ilorest. Save will automatically select the required type to make changes.

This command simultaneously logs in to the server at the provided URL --url with the provided username -u and password -p and load a file from the current working directory called biosconfig. This is the multi-server configuration setup. You must pass in a multi-server file in the following format. All servers are configured concurrently. Because the filename tag is included, it searches for the file called biosconfig.

If no values have changed, the load process is complete. If any property values have changed, the changes are committed and the user is logged out of the server. Logs of the entire process are then stored in the same location as the iLOrest logs. Loads the server configuration from a file.

Run this command without parameters to use the configuration found in the file called ilorest. Otherwise, you can point this command to use any file you specify. Use this function to change the properties of a type to new values. Optionally supply a filename to a multi-processing file to load concurrently on multiple servers.

Input a JSON object to load from a custom configuration file, otherwise the configuration will default to looking for a file called ilorest. The status command shows changes to be committed. The status command shows all pending changes, including changes for different types.

Displays all pending changes, regardless of which type is currently selected. All the changes that have not been committed yet will be shown.

Commit after running other commands by using the --commit option. This command simultaneously logs in to the server at the provided URL --url with the provided username -u, --user and password -p, --password , selects the ComputerSystem.

Applies all changes made during the current session. After you have changed one or more values for the property of a type, you need to commit those changes in order for those changes to be reflected on the server. To commit at the end of a command, include the --commit option. Not all commands have the commit flag, run help on the command to see available options. To log out at the end of a command, include the --logout option.

Not all commands have the logout flag, run help on the command to see available options. Use the exit command if you wish to exit from the interactive shell.

Using exit will also log you out and disconnect you from the server. This command simultaneously logs in to the server at the provided URL --url with the provided username -u and password -p , sets the bios back to default settings, then reboots --reboot the server to apply the changes. Using the reboot option automatically logs-out of the server. If you are not logged in yet, including this flag along with the password and URL flags can be used to login to a server in the same command.

Use the provided CA bundle or SSL certificate with your login to connect securely to the system in remote mode. This flag has no effect in local mode. Run without arguments to view the current persistent boot order, continuous and one time boot options, and continuous and one time boot UEFI options.

List numbers associated with the Current Persistent Boot Order list to set a new boot order. Any numbers left off of the new list will be added to the end. The commit flag will commit the changes, otherwise changes are not saved. Use partial string matching to set a boot order independent of the current boot order. All boot options not listed will be added to the end of the boot order. Change the one time boot order using the --onetimeboot option. Specify a option to boot to from the Continuous and one time boot options list.

Change the continuous boot order using the --continuousboot option. To turn off any continuous or one-time boot options that have been configured, use the --disablebootflag option.

This command prints a list of entries when no arguments are provided. Run this command with arguments to change the bootorder and set continuous and one-time boot settings. Arguments for the bootorder command include entries as a list, which is enumerated in the order of the default command. Entries provided are rotated, in order, to the top of the boot queue; missing entries are appended to the end of the new queue, in order.

Changes do not take effect until a reboot. To perform a one-time boot, continuous boot, or disable continuous boot or one-time boot, use the respective options. The boot order can be specified as a list of numbers or as a list of partial strings for matching. If omitted, displays the current boot order. See examples for usage and syntax. Use this flag to configure a one-time boot option. Using this flag will prioritize the provided boot source only on the very next time the server is booted.

Use this flag to enable a continuous boot option. Using this flag will cause the system to boot to the selected device every time the system boots.

Use this flag to perform actions on secure boot keys. Possible values include defaultkeys: resets all keys to default, deletekeys: deletes all keys, deletepk: deletes all product keys.

Use the list flag to retrieve the current configured iscsi boot attempts. If none are configured, then all sections will have a message stating Not Added. Modify properties for boot attempts by outputting them to a file, editing the file, then apply the changes with the --modify option. You must include the --list option with the -f option to write to a file.

To delete an iSCSI attempt use the --delete option, specifying which attempt to delete. Optionally include this flag to use the provided filename instead of the default ilorest. Run pending with no arguments to show current changes that have been committed to the server and are awaiting a reboot.

In this example, no changes have been found. After committing a change to AdminName the pending command shows the change to AdminName that will take effect on reboot. Run the command without any parameters to gather the results of any changes which occurred on the last reboot.

To set a new password, include the new password and the current password. These commands include operations such as turning the server hardware on and off, resetting iLO, and updating firmware. To restore a server using the. By default the command will search for a.

Specify a. Use this command to specify the which backup file to restore. By default, the command will try to find a. Use the provided password when creating the backup file. The same password must be used for restoring. Using this flag when not logged in will have no effect.

Use quotes to include parameters which contain whitespace. To retrieve the certificate signing request use the getcsr argument.

The default filename is certificate. Including the -f, --filename option will change the default name. To import a CA certificate use the ca argument followed by a file containing the certificate. To import a TLS certificate use the tls argument followed by a file containing the certificate.

Command for importing both iLO and login authorization certificates as well as generating iLO certificate signing requests. Use this flag if you wish to use a different filename for the certificate signing request. Generally not needed and shouldn't be done unless there are issues viewing info, setting, or committing data.

To view current LDAP or kerberos settings run the command with the ldap or kerberos arguments. The --enable flag was passed because previously the directory was disabled. Authentication schema and search strings can only be used with the LDAP directory. Realm and key tab can only be used with the Kerberos directory.

Available roles can be found in the help text. To add custom local role maps include the ldap argument with the --addrolemap option with the form PrivNum1;PrivNum2; Numbers of privileges can be found in the help text.

To remove directory role maps include the ldap argument with the --removerolemap option specifying the LocalRole of the role map to remove.

Multiple role maps can be removed by separating them with commas. To perform directory tests use the test argument followed by start to start the directory test, stop to stop the directory test, or viewresults to view the results of the last directory test. Login 2. Remote Console 3. User Config 4. Virtual Media 6. Virtual Power and Reset 7. Host NIC Config 8. Host Bios Config 9.

Host Storage Config System Recovery Config Self Password Change Configure Components. Use this command to choose a LDAP authentication mode. Use this command to change the displayed output to JSON format. Preserving the JSON data structure makes the information easier to parse. To test the ESKM connections use the testconnections argument. The response will indicate if the system can connect properly or if there is an issue.

Provide a proxy server and port. Note : Non-existent interfaces will be omitted from configuration. Configure Static IPv4 Settings. Provide a list of network settings. To reset iLO to factory defaults in the current logged in server run the command without arguments. To update firmware specify the URI location of the firmware. The user will be logged out after firmware update completes successfully.

Use this command to update the firmware via URI. This command only supports firmware with a. Point the firmwareupdate command towards the. Input a URI pointing to a. To perform a firmware integrity check and return results of the check include the --results option. To list the current iLO accounts on the system and their information, run the command without arguments. To optionally specify privileges at creation, use the --addprivs option with numbers from the privilege list.

To change the password of an account run the command with the changepass argument, specifying the Id or the Username of the account to modify and the new password. To delete an iLO account run the command with the delete argument, specifying the Id or the Username of the account for deletion. To add a certificate to an account run the command with the addcert argument, specifying the Id or Username of the account followed by the path to an x.

To delete a certificate from an account run the command with the deletecert argument, specifying either the Id or Username of the account. Optionally include this flag if you wish to specify which privileges you want added to the iLO account.

Pick privileges from the privilege list in the above help text. Optionally include this flag if you wish to specify which privileges you want removed from the iLO account. Optionally include this flag if you would like to specify Privileges by role. Valid choices are: Administrator, ReadOnly, and Operator. To add an iLO federation group to the current logged in server include the add argument with the new federation name and federation key. To change the key of an iLO federation group include the changekey argument with the federation name and the new key.

To delete an iLO federation group include the delete argument with the federation name to delete. To modify an iLO federation group include the modify argument with the federation name you'd like to update. Optionally include this flag if you wish to specify which privileges you want added to the iLO federation.

This overrides the default of duplicating privileges of the currently logged in federation on the new federation. Optionally include this flag if you wish to specify which privileges you want removed from the iLO federation. To Apply an iLO license on the current logged in server run the command with the license key as an argument. To remove a profile, use the unique key contained in the profile with the -d, --delete option. To optionally skip the confirmation before initiating One Button Erase include the --confirm option.

Performs One Button Erase on a system. Use this command to skip monitoring of the one button erase process and simply trigger the operation. Use this command to skip the confirmation prompt before starting One Button Erase and begin the operation.

If the current power state does not allow for an operation to complete an error will be returned. Run this command to turn the system on, perform an immediate non-graceful shutdown, perform an immediate non-graceful shutdown followed by a restart of the system, generate a non-maskable interrupt and cause an immediate system halt, or simulate the pressing of the physical power button on the system.

Use this reboot type to perform an immediate non-graceful shutdown followed by a restart of the system. You can optionally choose to set the includelogs flag. Use this command to retrieve a Redfish response messages. The results command provides feedback after an iLO state change as a list of attributes that have been modified and a short message log that contains details regarding the state change. To save an iLO and Bios config run the command with the save argument. To save an iLO and Bios config while providing a placeholder value for all user inputs run the command with the save argument and include the --auto option.

This option can be used to problematically create a file without user input and then use a script to fill in the settings. To load a clone file run the command with the load argument. An example of simultaneously deleting one account and adding another within a JSON file.

Clone file snippet to be modified; the element to be removed is highlighted. Use this command during 'load' to include an SSO certificate. This should be properly formatted in a simple text file. Use this command during 'load' to include a TLS certificate. Allow for save to automatically archive the clone file and error log file. Use with load will archive the clone file, temporary patch file, error log file and changelog file.

Use this command to override the measures stopping the tool from writing over items that are system unique. This optional command provides preset credentials. The preset value of is used as the password for the iLO account manager accounts and the iLO federation group keys.

This is an optional command used to include configuration of iLO Smart Array Devices during save or load processes. Use option --proxy to view proxy settings. You can output the information to json file using --json or -j option. The filename is pre-generated from the server serial number and date and time the AHS log was gathered.

To view logs select a log using the --selectlog option. You can output logs to a file with the -f, --filename option.

This is only available for downloading remote AHS logs. Clear logs by selecting a log with --selectlog and including the -c, --clearlog option. This command will clear the AHS logs. To insert an IML log use the -m, --maintenancemessage flag. This is only available with IML logs. To set an IML log as repaired use the -r, --repair option. Specify the Id of a log to mark as repaired. You can only repair entries with severities of Critical or Warning.

Used to indicate the logs to be downloaded on multiple servers. To return the serverstate run the command without arguments. To delete a specific SSO record by running the command with the deleterecord argument and specify it by number.

To delete a specific SSO record by running the command with the deleterecord argument followed by the all keyword. To import a SSO certificate from a file run the command with the importcert argument followed by the certificate file to import.

To import a CA certificate use the import argument followed by a file containing the certificate. Command for importing or exporting X. Generate a certificate signing request. Retrieve a certificate signing request. Specify the id of the certificate to retrieve from the collection. Requires a certificate type selection. By default, the certificate is printed to the console. By default, the CSR is printed to the console. To insert virtual media specify the type of virtual media by Id number followed by the URI location to the image.

You can specify the media to boot next reset by including the --bootnextreset option. To remove an inserted media specify the type of virtual media by Id number and include the --remove option. To delete firmware by file name run the command with the file name as an argument. You can also delete multiple files by file name. To delete firmware by Id run the command with the file Ids as arguments.

You can also delete a single file by Id. To delete all firmware on the iLO repository run the command and include the --all option. The name or Id s of the components for deletion. Multiple components should be specified by a comma separated list without spaces. If you are not logged in yet, including this flag along with the password and URL flags can be used to log into a server in the same command.

Optionally include this flag if you would prefer to connect using a session id instead of a normal login. To upload firmware and flash or stage for a flash run the command with the.

To skip checks for something blocking firmware updates also include the --ignorechecks option. The path to the. Include this flag to ignore all checks to the taskqueue before attempting to process the. To add an install set run the command with the add argument followed by the install set json file.

If using sequence type json file see below the --name option must be included. To invoke an install set and have it start performing tasks run the command with the invoke argument followed by the -n, --name option specifying the name of the install set to invoke. To delete an install set run the command with the delete argument followed by the --name specifying the name of the install set to delete.

Optionally include this flag to set the expiry time for installset. Optionally include this flag to set the earliest execution time for installset.

ISO Redfish-style time string to be used. If set then the components in the flash operations are used to replace matching contents in the Recovery Set.

To list the firmware on the iLO repository of the currently logged in system run the command without arguments. To Create a new maintenance window run the command with the add keyword followed by the time the maintenance window should start. If you do not supply a name for your maintenance window one will be randomly generated for you. To delete a maintenance window run the command with the delete keyword followed by the name or id of the maintenance window you wish to delete.

Optionally include this flag to name the maintenance window created by you. If a name is not specified, system will add a unique name. Run to make installsets for iLO. If not logged into the server, the command will provide basic guidance on making an installset. If logged into the server, the command will provide guidance based on the current components on the system. Include this flag to use a different filename than the default one. The default filename is myinstallset. To create new wait task queue task include the create keyword followed by the amount of time to wait.

To create a new firmware task queue task include the create keyword followed by the name of a firmware file that is already in the iLO repository.

To delete all tasks from the update task queue run the command with the --resetqueue option. Command to add or remove tasks from the task queue. Added tasks are appended to the end of the queue. To upload firmware to the iLO repository run the command with the --component option specifying the firmware file to upload. By default the firmware is uploaded to the iLO Repository. For firmware iLO is capable of flashing you can instead directly flash it.

Component signature file path needed by iLO to authenticate the component file. If not provided, the command will try to find the signature file from component file path. The component uploaded will become a part of the system recovery set srs. To clear a controller configuration run the command including the --controller option specifying the controller to clear. To create a quick logical drive run the command with the following arguments: The type of creation as quickdrive, the raid level, the number of drives to use, the type of drive to use, the drive interface type, and the drive location.

Also include the --controller option selecting the controller the drive will be created on. See the options list for possible values of these and more. To create a custom logical drive run the command with the following arguments: The type of creation as customdrive, the raid level, and the physicaldrive drive location.

Optionally include to set the spare drives by the physical drive's drive Location usable in custom creation only. Optionally include to set the capacity of the drive in GiB usable in custom creation only, use -1 for max size.

Optionally include to choose the capacity in blocks use -1 for max size, usable in custom creation only. Optionally include to include the number of parity groups to use only valid for certain RAID levels. To delete multiple logical drives by drive location include the drive location of the drive you wish to delete.

Also include the --controller option specifying the controller to use. You can specify multiple drives as well as a comma separated list. To delete all logical drives on a controller include the --controller option specifying the controller to perform the operation on and the --all option. To sanitize a physical drive pass its drive location along with the --controller option to specify which controller to perform the operation on. To sanitize multiple physical drives pass the location as a comma separated list along with the --controller option to dpecify which controller to perform the operation on.

Include this flag to perform a coldboot command function after completion of operations and monitor sanitization. To factory reset a controller run this command and specify it's index with the --controller option. To list all Existing Volume Unique Identifier's for logical drives for all controllers run the command including the --logicaldrives option.

Drives which are pending will instead show "Pending Drive" for the Volume Unique Identifier this will be available after the system has been rebooted and the drive has been successfully created. The information is presented such that the controller slot number is noted first, followed by all associated logical drives to that controller.

To list all physical drives for all available controllers, run the command with the --physicaldrives option. The controller will be provided first followed by drive information as associated to that controller. To return a JSON formatted response including controller settings, as well as physical and logical drives information on the selected controller, include the --controller option followed by the number in brackets associated to the controller. To return a JSON formatted response regarding the settings and attributes of the selected physical drive on the selected controller include the --controller option specifying the controller and the --pdrive option specifying the physical drive number in brackets.

To return a JSON formatted response regarding the settings and attributes of the selected logical drive on the selected controller include the --controller option specifying the controller and the --ldrive option specifying the logical drive number in brackets. Optionally allows user to specify the percentage of total capacity that should be configured as Volatile. The remaining capacity will be configured as Persistent. Indicates whether the persistent memory regions should be interleaved or not Allowed values: "on", "off".

Optionally allows user to specify the processors comma separated list of ProcessorNumbers on which the selected configuration would be applied. Defaults to all processors. Can be used in conjunction with the -D --device or the -C --pmmconfig flags. Run to delete data from the passed in path. Use the --expand flag to expand collection URIs to include the response of collection members.

The full response has been truncated for space. Run to retrieve data from the passed in path. If you include the filename flag, this command will return an output file of the information retrieved when the rawget command was executed.

Run to retrieve header data from the passed in path. If you specify the filename flag, the rawhead command will output a file containing the information retrieved when performing the rawhead command. Run to send a patch from the data in the input file. Include the filename to use the data in the input file to send the patch es. One or more patches can be passed in one input file. An JSON file template is shown on the side. Run to post the data from the passed in path.

Include the filename to send a post from the data included in this input file. One or more posts can be passed in one input file. Include the filename to send a PUT from the data included in this input file. One or more puts can be passed in one input file. Selecting the EthernetInterface.

To return a single instance we can filter by a property value. In this case we are filtering by odata. By default, filter will attempt to match the property and value case insensitively, but exactly.

If no matches are found iLOrest will return an error. If there is more than one instance of a type on the system, when you select it, the filter option can be used to narrow down the results.

With this narrowed result, you can set specific instance properties, list specific instance properties, or get specific instance properties. To start type collection from a specific path include the --path option followed by the path to start from. This can limit or add new types depending on the path specified. The path option can set a different URI as the starting point for type discovery.

This option is useful if you wish to view specific types, which are not available by default or if you wish to lower the time it takes to login. It is not recommended to use this flag on systems with a resource directory.

This section outlines ready to use example commands, as well as some general use scenarios for obtaining and configuring iLO 4 iLO 4 2. Configured attributes in iLO are transferred by the BIOS provider and staged for implementation upon the next system reboot. The Bios type has two properties that both need to be used to change the administrator password, AdminPassword and OldAdminPassword.

AdminPassword is the new password you want to change to, and OldAdminPassword is the current password you have. If you perform a get command to find the current AdminPassword and OldAdminPassword values, you will notice that their values are listed as None , regardless of what their actual values are, as seen above.

In order to change the administrator password, you need to set the AdminPassword the new value you want and the OldAdminPassword what the admin password was before , as well as include the —biospassword flag if the system is iLO 4. After you've set the values for AdminPassword and OldAdminPassword , you need to commit your changes and reboot your server:.

Then when you log into the server again, the BIOS password will have been updated to the new value. Configure one time boot selection. The bootorder command is made up of a list of select, get, and set commands.

In order to demonstrate the order of these events, the bootorder command is manually stepped through one step at a time to show that it only uses other provided commands to perform its task. First the server is logged into, and the select and get commands are performed on the Bios type and the BootMode property, respectively. Next the select and get commands are used to retrieve the BootSourceOverrideSupported property of the ComputerSystem type. If this is not a one time boot or a continuous boot, and the disable boot flag has not been set, then the HpServerBootSettings type is selected with the select command, and the PersistentBootConfigOrder property is retrieved with the get command.

Then, using this information along with the specified boot order provided in the command, the new boot order is updated using the set command. After making all the changes to the boot order, the changes are finally committed with the commit command.

All of the commands shown here are executed the same way in the actual bootorder command, and are called in the same order to execute the bootorder command.

You can write your own scripts to combine commands just like bootorder did, to use the provided commands in the RESTful Interface Tool for higher-level functionality. Configure iLO licensing, set unit identification lamp, hotkey configuration, obtaining system power metrics, and configuring the iLO's time zone.

This script will alter the UID light state. We then list the TimeZoneList. Now scroll around looking for the timezone that is wanted. Take note of the index associated with the Name. Finally, we set the Index to 2. Check the status to make sure the change is queued and finally make sure to commit to finalize the changes. Next select the Power. Finally list powercontrol.

The powermetric average is represented by the AverageConsumedWatts value. In the provided example, many of the resources for the encryption setting are not available. Logs can be retrieved for analysis or cleared to wipe the slate.

The following examples are of interest:. Add a new iLO management user account. By default only the login privilege is provided equivalent to read-only predefined role.

Additional privileges and roleIDs for iLO 5 systems can be configured. Reset an iLO management account password. The first example is specifically for the default Administrator account, the second for any subsequently created account.

Add a new federation group by defining a federation name, key and associated privileges for the group. Transmitter PMA Datapath. Serializer 1. Transmitter Buffer. Transmitter Polarity Inversion 1. Bit Reversal. Transmitter Buffer Features and Capabilities 1. Programmable Transmitter Analog Settings 1. Programmable Transmitter VCM 1. Transmitter Protocol Specific. Receiver PMA Datapath. Receiver Buffer 1. Receiver Buffer. Programmable Receiver VCM 1.

Signal Threshold Detection Circuitry. Transmitter PLL. Channel PLL Architecture 1. Lock-to-Reference Mode 1. Lock-to-Data Mode 1. PCS Architecture. Transmitter PCS Datapath 1. Receiver PCS Datapath. Transmitter PCS Datapath. Byte Serializer 1. Transmitter Bit-Slip. Registered Mode 1. Phase Compensation Mode. Byte Serializer. Byte Serializer in Single-Width Mode 1. Byte Serializer in Double-Width Mode.

Running Disparity Control 1. Control Code Encoding 1. Reset Condition 1. Encoder Output During Reset Sequence. Word Aligner 1. Byte Deserializer 1. Byte Ordering 1. Word Aligner. Word Aligner Options and Behaviors 1. Word Aligner in Manual Alignment Mode 1. Word Aligner in Bit-Slip Mode 1. Programmable Run-Length Violation Detection 1. Receiver Polarity Inversion 1. Bit Reversal 1. Receiver Byte Reversal. Control Code Group Detection. Byte Deserializer.

Byte Deserializer in Single-Width Mode 1. Byte Deserializer in Double-Width Mode. Byte Ordering. Byte Ordering in Single-Width Mode 1. Byte Ordering in Double-Width Mode 1.

Word Aligner-Based Ordering Mode 1. Manual Ordering Mode. Registered Mode. Transceiver Clocking in Cyclone V Devices. Input Reference Clocking 2. Internal Clocking 2. Input Reference Clocking.

Dedicated Reference Clock Pins 2. Dedicated Reference Clock Pins. Dedicated refclk Using the Reference Clock Network 2. Internal Clocking. Transmitter Clock Network 2. Transmitter Clocking 2. Receiver Clocking.

Transmitter Clocking. Non-Bonded Channel Configurations 2. Bonded Channel Configurations. Receiver Non-Bonded Channel Configurations 2. Receiver Bonded Channel Configurations.

Transceiver Datapath Interface Clocking 2. Transmitter Datapath Interface Clocking 2. Receiver Datapath Interface Clock. Transmitter Datapath Interface Clocking. Selecting a Transmitter Datapath Interface Clock. Selecting a Receiver Datapath Interface Clock.