Integrated Dell Remote Access Controller 9 RACADM CLI Guide

PDF

set

Table 1. Details of setThe following table provides details about the set subcommand:
Description

Modifies the value of configuration objects on a component. The Set sub-command has two forms:

  • The modification of a single object to a new value specified in the command line.
  • The modification of multiple objects to new values using a configuration file.

    It supports multi-object value import from the below configuration file format:

    • Server Configuration Profile(SCP) XML and JSON format—XML and JSON format files can be imported from a local file, from an NFS, CIFS, HTTP, HTTPS, FTP and TFTP network share.
      NOTE:You need admin user privilege to perform import and export SCP operations.

    Depending on the type of configuration object being modified, the new values could be applied immediately (in “real-time”) or require staging and a reboot of the system to apply the new values. The following components support either real-time or staged application of new values:

    • iDRAC with Lifecycle Controller
    • PowerEdge RAID controllers
      NOTE:Use PowerEdge RAID controllers with firmware version 9.1 or later. The real-time support is provided only while performing hardware RAID configuration.

The following components require staging and system reboot for application of new values:

  • BIOS
  • Other PowerEdge RAID controllers — For software RAID configuration
  • Networking devices – Ethernet and Fibre Channel
NOTE:
  • To modify the value of staged objects such as BIOS or NIC, commit and reboot job creation must be used to apply the pending values. When single object Setoperations are used to stage value modification, use the jobqueue command to schedule a job to reboot the server and apply the new values. For staged multi-object Setoperations using xml configuration files, a job will automatically be created by the Set command; use the –b, -w and -s options to specify how the staged reboot will be performed. For more information, see jobqueue.
  • Import and Export of INI file type doesn't support -c option for firmware versions earlier than iDRAC 4.40.00.00.
  • For more information on the set subcommand, run the RACADM command racadm help set.
Synopsis

Single-object Set 

  • racadm set <FQDD Alias>.<group> <value>
  • racadm set <FQDD Alias>.<group>.<object> <value>
  • racadm set <FQDD Alias>.<group>.[<index>].<object> <value>
  • racadm set <FQDD Alias>.<index>.<group>.<index>.<object> <value>

Multi-object Set 

  • racadm set -f <filename> -t xml -l <NFS share> [--preview] [--continue]
  • racadm set -f <filename> -t xml -l <NFS share> -c <FQDD>[,<FQDD>*]
  • racadm set -f <filename> -t xml -u <username> -p <password> -l <CIFS share> [--preview] [--continue] 
  • racadm set -f <filename> -t xml -u <username> -p <password> -l <CIFS share> -c <FQDD>[,<FQDD>*]
  • racadm set -f <filename> -t <file_type> -u <user> -p <pass> -l <location> \ [-s <state>] [-c <component_FQDD>] [--preview] [--customdefaults]
  • racadm set --savecustomdefaults
  • Configure a RAC from an XML configuration file located on a remote NFS share 
    racadm set -f <filename> -t xml -l <NFS> 10.1.2.3:/myshare
  • Configure a RAC from an XML configuration file located on a remote HTTP share. 
    racadm set -f <filename> -t xml -u <httpuser> -p <httppwd> -l <HTTP> http://test.com/myshare
  • Configure a RAC from an XML configuration file located on a remote HTTPS share. 
    racadm set -f <filename> -t xml -u <httpsuser> -p <httpspwd> -l <HTTPS> https://test.com/myshare
  • Configure a RAC from an XML configuration file located on a remote FTP share 
    racadm set -f <filename> -t xml -u <username> -p <password> -l <FTP share> -c <FQDD>
  • Configure a RAC from an XML configuration file located on a remote TFTP share. 
    racadm set -f <filename> -t xml -l <TFTP share> -c <FQDD>
  • To modify the value of InfiniBand attribute 
    racadm set <InfiniBand Attribute> <value>
Input
  • <FQDD Alias>

    Examples for FQDDs:

    • System.Power
    • System.Power.Supply
    • System.Location
    • LifecycleController.LCAttributes
    • System.LCD
    • iDRAC.Serial
  • <group> — Specifies the group containing the object that must be written.
  • <object> — Specifies the object name of the value that must be written.
  • <index> — This option is specified where FQDD Aliases or Groups must be indexed.
  • -f <filename> — Enables set to configure the device from a specified file. This option is not supported in the Firmware RACADM interface.
  • -u — Specifies user name of the CIFS remote share from which the file must be imported
  • -p — Specifies password for the remote CIFS share from which the file must be imported.
  • -l — Specifies network share location from where the file must be imported.
  • -t — Specifies the file type to be imported.
    The valid values are:
    • xml—Imports the Server Configuration Profile in XML format either from a local or network share file.
    • JSON—Specifies a JSON file.

Staging and reboot control options

The following options control when and how system reboots are performed when using the –f option. As noted above, some FQDDs require a system reboot to apply the new values; other FQDDs optionally support immediate application of new values. If the imported file contains ONLY immediate application-capable FQDDs such as iDRAC, do NOT use the –b option and the Set command will schedule a real-time job to immediately apply the new values.

NOTE:The –b, -w, –s, and --preview options are applicable only with –f option.
  • -b—Specifies the host shutdown type to run scheduled import job. The parameters are Graceful, Forced, and NoReboot for graceful shutdown, forced shutdown, and no reboot respectively. If -b is not specified, graceful shutdown is taken as the default except as noted above for files containing new values for immediate application-capable <FQDD>s.
    NOTE:If the operating system is in use, then the graceful shutdown option may time out within 300 seconds. If this operation is unsuccessful, then retry with the force option.
  • -w—Maximum time to wait for the graceful shutdown to occur. The value must be entered in seconds. Minimum accepted value is 300 seconds and the maximum accepted value is 3600 seconds. The default value is 1800 seconds.
  • -s—Power state of the host when the import operation completes. The parameters are "On" for powered ON and "Off" for powered OFF. If this parameter is not specified, power ON is taken as default.
  • --preview—Validates the configuration .xml file and view the status.

    The --preview option provides the Job ID to verify the status of the file preview operation. The Job ID can be tracked by running the racadm jobqueue view –I <JID> command.

    NOTE:
    • The --preview option does not restart the system.
    • The-b,-w options cannot be included with the --preview option.
    • A scheduled job or pending configuration should not be running while using the --preview option.
  • -c—Specifies the FQDD or list of FQDDs separated by ',' of the components for which the configurations should be imported. If this option is not specified, configuration related to all the components are imported.
NOTE:
  • To use the -c or --preview option, the minimum Lifecycle Controller version required is 1.2.
  • On certain devices, importing the server configuration profile requires two imports to apply the configuration to all the devices. The first import of the profile enables hidden devices which are then configured with a second import. The devices that require two imports are as follows:
    • PERC S110 and PERC S130 controllers
    • PERC S110 and PERC S130 controllers
    • BIOS and PCIe device: enabling PCIe slots in the system that are disabled and configuring the PCIe device
    • BIOS: enabling processor trusted execution (TXT) when server has Trusted Platform Module (TPM) 2.0 installed
    • BIOS: if SCP contains only a BIOS section that includes switching boot mode to UEFI and configuration of UEFI PXE network settings
    • BIOS: if SCP contains only a BIOS section that includes switching boot mode to legacy BIOS or UEFI along with changes to the boot order sequence using changes to BootSeq, HddSeq, or UefiBootSeq attributes.
    • BIOS: changing TPM 2.0 cryptographic support from the default of SHA-1
      NOTE:Boot mode and boot order sequence can be changed with a single SCP import if the SetBootOrderFqddN and SetLegacyHddOrderFqddN attributes are used.
  • --savecustomdefaults—Saves current configuration as custom default configuration.
  • --customdefaults—Performs the upload of custom default configuration file. This option should not be combined with --preview. Supports XML file type only.

This command does not support setting the proxy parameters if the share location (-l) is HTTP/HTTPS. For more information, see Proxy parameter section.

Example

Single-object Set of real-time objects

  • Configure LCD String. 
    racadm set system.lcd.LCDUserString test
    • Configure iDRAC name.
    racadm set iDRAC.Info.Name idrac-server100

Single-object Set of staged objects

  • Configure several BIOS settings, create a job to initiate application of new values, reboot the system, then wait for the job to complete.

    racadm set BIOS.SysProfileSettings.ProcTurboMode Disabled
    racadm set BIOS.ProcSettings.ProcVirtualization Enabled
    racadm set BIOS.ProcSettings.ControlledTurbo Enabled
    racadm jobqueue create BIOS.Setup.1-1 –r Graceful

    • Note of the Job ID output by the jobqueue command
    • After reboot, wait for the job to complete by checking the job status

      racadm jobqueue view –i <Job ID>

Multi-object Set of real-time objects

  • Configure the iDRAC using a local Server Configuration Profile XML file containing only iDRAC settings.

    racadm set -f myidrac.xml -t xml

  • Configure the iDRAC using a Server Configuration Profile XML file stored on an NFS share containing only iDRAC settings.

    racadm set -f myidrac.xml -t xml -l 10.1.2.3:/myshare

  • Import a Server Configuration Profile from a CIFS share, using only the iDRAC component.

    racadm set -f file –t xml -u myuser -p mypassword -l //192.168.0/share -c iDRAC.Embedded.1

Multi-object Set of staged objects

  • Configure a systems using a local Server Configuration Profile XML file containing a mix of real-time and staged objects; reboot the server gracefully with a wait time of ten minutes, leaving the server powered on after the reboot.

    racadm set -f myfile.xml -t xml -b "graceful" -w 600 -s "on"

    • Make note of the Job ID output by the Set command.
    • After reboot, wait for the job to complete by checking the job status.

      racadm jobqueue view –i <Job ID>

  • Configure a systems using a local Server Configuration Profile XML file containing a mix of real-time and staged objects; postpone reboot until other operations have been completed.

    racadm set -f myfile.xml -t xml -b NoReboot

    • Make note of the Job ID output by the Set command; because of the NoReboot option, the job will be pending until the server is rebooted
    • Complete other operations, then perform a reboot
    • After reboot, wait for the job to complete by checking the job status

      racadm jobqueue view –i <Job ID>

  • Verify the Server Configuration Profile XML file content located in a remote CIFS share. 
    racadm set -f temp_Configuration_file -t xml -u Administrator -p Password -l //192.168.0/xyz –preview
  • Configure a RAC from an XML configuration file located on a remote FTP share. 
    racadm set -f myfile.xml -t xml -u username -p password -l ftp://192.168.10.24/
  • Configure a RAC from a JSON configuration file located on a remote FTP share. 
    racadm set -f myfile.xml -t json -u httpsuser -p httpspwd -l ftp://192.168.10.24/
  • Configure a RAC from an XML configuration file located on a remote TFTP share. 
    racadm set -f myfile.xml -t xml -l tftp://192.168.10.24/
  • Configure a RAC from a JSON configuration file located on a remote TFTP share. 
    racadm set -f myfile.xml -t json -l tftp://192.168.10.24/
  • Configure a RAC from an XML configuration file located on a remote HTTP share. 
    racadm set -f myfile.xml -t xml -u httpuser -p httppwd -l http://test.com/myshare
  • Configure a RAC from an XML configuration file located on a remote HTTPS share. 
    racadm set -f myfile.xml -t xml -u httpsuser -p httpspwd -l https://test.com/myshare
  • Configure a RAC from a JSON configuration file located on a remote HTTPS share. 
    racadm set -f myfile.xml -t json -u httpsuser -p httpspwd -l https://test.com/myshare
  • Configure the proxy parameter. 
    racadm set lifecyclecontroller.lcattributes.UserProxyUsername admin1
  • Remove the proxy parameter. 
    racadm set lifecyclecontroller.lcattributes.UserProxyUsername
  • Upload the custom default XML configuration file located on NFS share to RAC. 
    racadm set -f myfile.xml -t xml -l share_ip:/PATH --customdefaults
  • Save current configuration as custom default configuration. 
    racadm set --savecustomdefaults

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\