shariqiqbal1 / dell-idrac Goto Github PK

#iDrac

####Table of Contents

1. Overview
2. importbiosconfiguration
3. importnparsetting
4. importraidconfiguration
5. importsystemconfiguration
6. exportsystemconfiguration

##Overview

The Dell iDrac module allows the user to configure the iDrac on a Dell server. The module can be used to configure RAID, bios and network settings by providing valid XML input to the Dell Lifecycle controller.

##importbiosconfiguration

###Description

The BIOS type/provider can be used to configure various BIOS parameters on the Dell Server

####Summary of Properties

1. dracipaddress - (Mandatory) This parameter defines the server iDRAC IP Address.

2. dracusername - (Mandatory) This parameter defines the server iDRAC username.

3. dracpassword - (Mandatory) This parameter defines the server iDRAC password.

4. nfsipaddress - (Mandatory) This parameter defines the local NFS server IP address.

5. nfssharepath - (Mandatory) This parameter defines the local NFS export path. Note: NFS export must be created or mounted on the local machine.

6. memtest - This parameter configures memtest on the server. The valid values are Enabled or Disabled. The default value is Disabled.

7. procvirtualization - This parameter enables or disables VT for the processor. The valid values are Enabled or Disabled. The default value is Enabled.

8. proccores - This parameter sets the number of processor cores to be enabled. The default value is "All"

9. bootmode - This parameter sets the BIOS boot mode. The default value is "bios".

10. bootseqretry - This parameter determines whether or not the BIOS must retry the boot. The valid values are Enabled or Disabled. The default value is Enabled.

11. integratedraid - This parameter enables or disables the Integrated RAID controller. The valid values are Enabled or Disabled. The default value is Disabled.

12. usbports - This parameter sets the number of USB ports to be enabled. The default value is "AllOn".

13. internalusb - This parameter defines if the internal USB controller is on or off. The default value is "off".

14. internalsdcard - This parameter defines if the internal SD card is on or off. The default value is "on".

15. internalsdcardredundancy - This parameter sets the redundancy for the internal SD card. The default value is "Mirror".

16. integratednetwork1 - This parameter defines if the first integrated network controller is enabled or disabled. The default value is Enabled.

##importnpartsetting

###Description

The importnparsetting type/provider supports the functionality to Enable and Disable NPAR setting on the Dell Server.

####Summary of Properties

1. nic - (Mandatory) This parameter defines the target NIC where the NPAR settings are to be modified.

2. status - (Mandatory) This parameter defines whether to enable or disable the NIC partitioning on a given NIC.

3. dracipaddress - (Mandatory) This parameter defines the server iDRAC IP Address.

4. dracusername - (Mandatory) This parameter defines the server iDRAC username.

5. dracpassword - (Mandatory) This parameter defines the server iDRAC password.

6. nfsipaddress - (Mandatory) This parameter defines the local NFS server IP address.

7. nfssharepath - (Mandatory) This parameter defines the local NFS export path. Note: NFS export must be created or mounted on a local machine.

##importraidconfiguration

###Description

The raid type/provider can be used to configure RAID on the Dell Server.

####Summary of Properties

1. dracipaddress - (Mandatory) This parameter defines the server iDRAC IP Address.

2. dracusername - (Mandatory) This parameter defines the server iDRAC username.

3. dracpassword - (Mandatory) This parameter defines the server iDRAC password.

4. nfsipaddress - (Mandatory) This parameter defines the local NFS server IP address.

5. nfssharepath - (Mandatory) This parameter defines the local NFS export path. Note: NFS export must be created or mounted on the local machine.

6. disk - This parameter denotes the comma seperated list of disks that are to be used for the RAID configuration.

7. raidtype - This parameter denotes the RAID level to be set. The valid values are 0 or 1. The default value is 0.

##importsystemconfiguration

###Description

The importsystemconfiguration type/provider can be used to import a single XML that defines the complete iDrac state.

####Summary of Properties

1. dracipaddress - (Mandatory) This parameter defines the server iDRAC IP Address.

2. dracusername - (Mandatory) This parameter defines the server iDRAC username.

3. dracpassword - (Mandatory) This parameter defines the server iDRAC password.

4. nfsipaddress - (Mandatory) This parameter defines the local NFS server IP address.

5. nfssharepath - (Mandatory) This parameter defines the local NFS export path. Note: NFS export must be created or mounted on the local machine.

6. configxmlfilename - (Mandatory) This parameter denotes the name of the XML file that is to be applied on the remote iDrac. This file should already be present on the nfs share path defined above.

##exportsystemconfiguration

###Description

The exportsystemconfiguration type/provider can be used to export the current iDrac configuration XML to a defined nfs share.

####Summary of Properties

1. dracipaddress - (Mandatory) This parameter defines the server iDRAC IP Address.

2. dracusername - (Mandatory) This parameter defines the server iDRAC username.

3. dracpassword - (Mandatory) This parameter defines the server iDRAC password.

4. nfsipaddress - (Mandatory) This parameter defines the local NFS server IP address.

5. nfssharepath - (Mandatory) This parameter defines the local NFS export path. Note: NFS export must be created or mounted on the local machine.

6. configxmlfilename - (Mandator) This parameter describes the name of the XML file that will contain the iDrac system configuration after the export is completed.