Integrated Dell Remote Access Controller 9 RACADM CLI Guide

PDF

get

Table 1. Details of getThe following table provides details about the get subcommand:
get
Description	Displays the value of one or more objects. The get subcommand has two forms. Displays the value of a single object. Exports the value of multiple objects to a file. It supports multiple object value exports in the below 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. NOTE: Some objects may have a pending value if a Set operation is performed on the object through a reboot job. To complete the pending operation, schedule the job using a jobqueue command, and then check for completion of the job using the returned Job ID. For more information, see jobqueue. Import and Export of INI file type doesn't support -c option for firmware versions earlier than iDRAC version 4.40.00.00. For more information on the get subcommand, run the RACADM command racadm help get Autobackup will return a license error from iDRAC version 4.40.00.00 release for Rx4xx and Mx4xx platforms. The command will display this error as the feature and the corresponding license will be removed. For HddSeq, BootSeq and UefiBootSeq attributes, a maximum of 32 device list is supported. For Unique FQDDs, use the iDRAC Redfish interface.
Synopsis	Single-object Get racadm get <FQDD Alias>.<group> racadm get <FQDD Alias>.<group>.<object> racadm get <FQDD Alias>.<group>.[<index>].<object> racadm get <FQDD Alias>.<index>.<group>.<index>.<object>
Synopsis	Multi-object Get racadm get -f <filename> -t xml -l <NFS share> [--clone \| --replace ] [--includeph] racadm get -f <filename> -t xml -l <NFS share> -c <FQDD>[,<FQDD>] racadm get -f <filename> -t xml -u <username> -p <password> -l <FTP share> -c <FQDD> racadm get -f <filename> -t xml -l <TFTP share> -c <FQDD> racadm get -f <filename> -t xml -u <username> -p <password> -l <CIFS share> [--clone \| --replace ] [--includeph] racadm get -f <filename> -t xml -u <username> -p <password> -l <CIFS share> -c <FQDD>[,<FQDD>] racadm get -f <filename> -t xml -u <username> -p <password> -l <HTTP share> -port <port number> -c <FQDD> racadm get -f <filename> -t xml -u <username> -p <password> -l <HTTPS share> -port <port number> -c <FQDD> racadm get -f <filename> -t xml --customdefaults racadm get -f -t xml -l <NFS share> [--clone \| --replace ] [-- includeph] [--includeCustomTelemetry] racadm get -f -t xml -u -p -l <CIFS share> [--clone \| --replace ] [--includeph] [--includeCustomTelemetry]
Input	<FQDD Alias> Examples for FQDDs System.Power System.Power.Supply System.Location LifecycleController.LCAttributes System.LCD iDRAC.Serial For the list of supported groups and objects under the get command, see Database objects with get and set commands. <group>—Specifies the group containing the object that must be read. <object>—Specifies the object name of the value that must be read. <index>—Specifies where FQDD Aliases or Groups must be indexed. -f <filename>—This option enables you to export multiple object values to a file. This option is not supported in the Firmware RACADM interface. -u—Specifies user name of the remote CIFS share to which the file must be exported. -p—Specifies password for the remote CIFS share to which the file must be exported. -l—Specifies network share location to which the file is exported. -port—Specifies the port number. NOTE:This is an optional parameter. If this option is not specified, the default port number is used. -t—Specifies the file type to be exported. The valid values are: JSON—It exports the SCP JSON file to a network share file. xml—It exports the SCP xml format file, either to a local or network share file. --clone—Gets the configuration .xml files without system-related details such as service tag. The .xml file received does not have any virtual disk creation option. --replace—Gets the configuration .xml files with the system-related details such as service tag. -c—Specifies the FQDD or list of FQDDs separated by ',' of the components for which the configurations should be exported. If this option is not specified, the configuration related to all the components are exported. --includeph—Specifies that the output of the passwords included in the exported configuration .xml file are in the hashed format. NOTE:if --includeph is not used, the output of the passwords are in the .xml file in clear text. --customdefaults—Exports custom default configuration to file. Supports only with XML file type and local share. --includeCustomTelemetry—Includes Telemetry Custom Metric Report Definitions (MRDs) in the configuration XML file. NOTE: For --clone and --replace options, only .xml file template is received. These options --clone and --replace cannot be used in the same command. --customdefaults and --includeCustomTelemetry cannot be used in the same command. This command does not support proxy parameters. To perform the operation with http and https, the proxy parameters has to be configured in the lifecyclecontroller.lcattributes. Once these proxy parameters are configured, they become the part of default configuration. They have to be removed to ignore the proxy parameters. This command does not support setting the proxy parameters if the share location (-l) is HTTP/HTTPS. To perform the operation with HTTP or HTTPS through a proxy, the proxy parameters must be first configured using the lifecyclecontroller.lcattributes. Once these proxy parameters are configured, they become the part of default configuration; the proxy attributes should be cleared to end use of the HTTP/HTTPS proxy. The valid lifecyclecontroller.lcattributes HTTP/HTTPS proxy parameters are: UserProxyUserName UserProxyPassword UserProxyServer UserProxyPort UserProxyType To view the list of proxy attributes, use racadm get lifecycleController.lcAttributes.
Examples	Get system LCD information. racadm get system.lcdLCDUserString Display an entire group, in this case the topology configuration. racadm get system.location Display a single object from a particular group. racadm get system.location.rack.name Export the xml configuration to a CIFS share. racadm get -f file -t xml -u myuser -p xxx -l //192.168.0/share Export the xml configuration to an NFS share. racadm get -f file -t xml -l 192.168.0:/myshare Export a “cloned” xml configuration to a CIFS share racadm get -f xyz_temp_clone -t xml -u Administrator -p xxx -l //192.168.0/xyz --clone Export a “replace” xml configuration to a CIFS share racadm get -f xyz_temp_replace -t xml -u Administrator -p xxx -l //192.168.0/xyz --replace Export the xml configuration of the iDRAC component to FTP share. racadm get -f file -t xml -u username -p password -l ftp://192.168.10.24/ Export the JSON configuration of the iDRAC component to FTP share. racadm get -f file -t json -u username -p password -l ftp://192.168.10.24/ Export the xml configuration of the iDRAC component to TFTP share. racadm get -f file -t xml -l tftp://192.168.10.24/ Export the JSON configuration of the iDRAC component to TFTP share. racadm get -f file -t json -l ftp://192.168.10.24/ Export the xml configuration of the iDRAC component to a CIFS share. racadm get -f file -t xml -u myuser -p xxx -l //192.168.0/share -c iDRAC.Embedded.1 Export the xml configuration of the iDRAC component to NFS share. racadm get -f file -t xml -l 10.1.12.13:/myshare Export the xml configuration of the iDRAC component to HTTP share. racadm get -f file -t xml -u httpuser -p httppwd -l http://test.com/myshare -port 8080 Export the xml configuration of the iDRAC component to HTTPS share. racadm get -f file -t xml -u httpuser -p httppwd -l https://test.com/myshare -port 8080 Export the JSON configuration of the iDRAC component to HTTP share. racadm get -f file -t json -u httpuser -p httppwd -l http://test.com/myshare -port 8080 Export the JSON configuration of the iDRAC component to HTTPS share. racadm get -f file -t json -u httpuser -p httppwd -l https://test.com/myshare -port 8080 Export the custom default xml configuration to local share. racadm get -f file -t xml --customdefaults Include Telemetry Custom Metric Report Definitions in the configuration .xml file. racadm get -f <filename> -t xml -l <NFS or CIFS share> -u <username> -p <password> --includeCustomTelemetry Include password hash in the configuration .xml file. racadm get -f<filename> -t xml -l<NFS or CIFS share> -u<username> -p<password> -t xml --includeph Configure proxy parameters. racadm set lifecyclecontroller.lcattributes.UserProxyUsername admin1 racadm set lifecyclecontroller.lcattributes.UserProxyUsername View the list of proxy attributes. racadm get lifecycleController.lcAttributes To display InfiniBand related groups. racadm get InfiniBand