Ipmicfg: Difference between revisions

From Omnia
Jump to navigation Jump to search
No edit summary
Line 10: Line 10:


  ipmicfg-win.exe -m
  ipmicfg-win.exe -m
== Help Options ==
<pre>
IPMICFG Version 1.32.0 (Build 200910)
Copyright(c) 2020 Super Micro Computer, Inc.
Usage: IPMICFG params (Example: IPMICFG -m 192.168.1.123)
-help                      Display a list of commands
-m                        Shows IPv4 address and MAC.
-m <ip>                    Sets IPv4 address (format: ###.###.###.###).
-a <mac>                  Sets MAC (format: ##:##:##:##:##:##).
-k                        Shows Subnet Mask.
-k <mask>                  Sets Subnet Mask (format: ###.###.###.###).
-dhcp                      Gets the DHCP status.
-dhcp on                  Enables the DHCP.
-dhcp off                  Disables the DHCP.
-g                        Shows a Gateway IP.
-g <gateway>              Sets a Gateway IP (format: ###.###.###.###).
-garp on                  Enables the Gratuitous ARP.
-garp off                  Disables the Gratuitous ARP.
-r                        Performs a BMC cold reset.
                            Detects if a BMC reset was successfully performed
                            on the IPMI device, use -d after -r.
-fd <option>              Resets to the factory defaults without preserving
                            configurations.
                            option:  1 | Preserves User configurations
                            option:  2 | Restores to factory default and
                            default password
                            option:  3 | Sets user defaults to ADMIN/ADMIN
-fdl                      Resets IPMI to the factory default. (Clean LAN).
-fde                      Resets IPMI to the factory default. (Clean FRU &
                            LAN).
-d                        Detects if a BMC reset was successfully performed
                            on the IPMI device.
                            Note that this option can be only used after -r,
                            -fd, -fdl or -fde
-ver                      Gets firmware revision.
-vlan                      Gets VLAN status.
-vlan on [VLAN tag]        Enables the VLAN and sets the VLAN tag.
                            If VLAN tag is not given, it uses the previously
                            saved value.
-vlan off                  Disables the VLAN.
-selftest                  Checks and reports the basic health status of the
                            BMC.
-raw                      Sends a RAW IPMI request and prints a response.
                            Format: NetFn/LUN Cmd [Data1 ... DataN]
-fru info                  Shows information of the FRU inventory area.
-fru list                  Shows all FRU values.
-fru cthelp                Shows chassis type code.
-fru help                  Shows help of FRU Write.
-fru <field>              Shows FRU field value.
-fru <field> <value>      Writes FRU.
-fru backup <file>        Backs up FRU to a file <Binary format>.
-fru restore <file>        Restores FRU from a file <Binary format>.
-fru tbackup <file>        Backs up FRU to a file <Text format>.
-fru trestore <file>      Restores FRU from a file <Text format>.
-fru ver <v1> <v2>        Gets/Sets the FRU version. (<v1> and <v2> are
                            BCD-format)
-sel info                  Shows SEL information.
-sel list                  Shows SEL records.
-sel del                  Deletes all SEL records.
-sel raw                  Shows SEL raw data.
-sdr [full]                Shows SDR records and readings.
-sdr del <sdr id>          Deletes the SDR record.
-sdr ver <v1> <v2>        Gets/Sets the SDR version. (<v1> and <v2> are
                            BCD-format)
-nm nmsdr                  Displays NM SDR.
-nm seltime                Gets SEL time.
-nm deviceid              Gets the ID of the ME device.
-nm reset                  Reboots ME.
-nm reset2default          Forces ME to reset to default settings.
-nm updatemode            Forces ME to enter the update mode.
-nm selftest              Gets self-test results.
-nm listimagesinfo        Lists ME information of images.
-nm oemgetpower            OEM Power command for ME.
-nm oemgettemp            OEM Temp. command for ME.
-nm pstate                Gets the maximum allowed CPU P-State.
-nm tstate                Gets the maximum allowed CPU T-State.
-nm cpumemtemp            Gets CPU/memory temperature.
-nm hostcpudata            Gets the host CPU data.
-fan                      Gets the fan mode.
-fan <mode>                Sets the fan mode.
-pminfo [full]            Displays PMBus health information of power supply.
-psfruinfo                Displays FRU health information of power supply.
-psbbpinfo                Displays status of the backup battery.
-autodischarge <module>    Sets auto discharge by days.
  <day>
-discharge <module>        Manually discharges a battery.
-user list                Lists user privileges.
-user help                Shows a user privilege code.
-user add <user id> <name> Adds a user.
  <password> <privilege>
-user del <user id>        Deletes users.
-user level <user id>      Updates user privileges.
  <privilege>
-user setpwd <user id>    Updates a user password.
  <password>
-conf download <file>      Downloads IPMI configuration to a binary file.
-conf upload <file>        Uploads IPMI configuration from a binary file.
  <option>                  option: -p | Bypass warning message
-conf tdownload <file>    Downloads IPMI configuration to a text file.
-conf tupload <file>      Uploads IPMI configuration from a text file.
  <option>                  option: -p | Bypass warning message
-clrint                    Clears chassis intrusion.
-reset <index>            Resets system and forces to boot from the selected
                            device.
-soft <index>              Initiates a soft-shutdown for OS and forces system
                            to boot from the selected device.
-ipv6 mode                Shows the IPv6 mode.
-ipv6 mode <mode>          Sets the IPv6 mode.
-ipv6 autoconfig          Shows IPv6 auto configuration.
-ipv6 autoconfig on        Enables IPv6 auto configuration.
-ipv6 autoconfig off      Disables IPv6 auto configuration.
-ipv6 list                Lists IPv6 static and dynamic addresses.
-ipv6 duid                Shows IPv6 DUID.
-ipv6 dns [ip]            Gets/Sets IPv6 DNS server.
-ipv6 add <id> <ip>        Adds IPv6 static address.
  <prefix>
-ipv6 remove <id>          Removes IPv6 static address.
-ipv6 route                Displays IPv6 static route.
-ipv6 route on            Enables IPv6 static route.
-ipv6 route off            Disables IPv6 static route.
-ipv6 route list          Lists IPv6 static router information.
-ipv6 route <id> <prefix  Sets IPv6 static router information.
  value> <prefix length>
  <ip>
-ipv6 route clear <id>    Clears IPv6 static router information.
-nvme list                Displays the existing NVME SSD list.
-nvme info                Displays NVME SSD information.
-nvme rescan              Rescans all devices by in-band.
-nvme insert <aoc> <group> Inserts SSD by out-of-band.
  <slot>
-nvme locate <HDD name>    Locates SSD. (in-band)
-nvme locate <aoc> <group> Locates SSD. (out-of-band)
  <slot>
-nvme stoplocate <HDD      Stops locateing SSD. (in-band)
  name>
-nvme stoplocate <aoc>    Stops locateing SSD. (out-of-band)
  <group> <slot>
-nvme remove <HDD name>    Removes NVME device. (in-band)
  [option1] [option2]      option1: 0 | Do eject after remove (Default)
                            option1: 1 | Do not eject after remove
                            option2:-p | Bypass warning message
-nvme remove <aoc> <group> Removes NVME device. (out-of-band)
  <slot> [option]          option: -p | Bypass warning message
-nvme smartdata [HDD name] NVME S.M.A.R.T data.
-tas info                  Gets TAS information.
-tas pause                Pauses a TAS service.
-tas resume                Resumes a TAS service.
-tas refresh              Triggers TAS to recollect data.
-tas clear                Clears collected TAS data in BMC.
-tas period <sec>          Sets the time length of a TAS update <limit 5 to 60
                            sec>.
-tas exec <cmd>            Executes a user's specified command.
-tp info                  Gets MCU information.
-tp info <type>            Gets information of MCU type. (type: 1 - 3)
-tp nodeid                Gets a node ID.
-summary                  Displays FW and BIOS information.
-hostname [value]          Gets/Sets a host name.
-dcmi cap                  Lists information of DCMI capabilities.
-dcmi power                Gets the DCMI power readings.
-dcmi ctl [value]          Gets/Sets the DCMI management controller ID string.
-mel list                  Shows BMC maintenance event log.
-mel download <file>      Downloads a BMC maintenance event log to a file.
-mel clear                Clears a BMC maintenance event log.
-addrptl [option]          Gets/Sets IP address protocol.
                            option:  1 | IPv4
                            option:  2 | IPv6
                            option:  3 | Dual
-lockdown [option]        Checks the system's status mode or puts the system
                            in lockdown mode.
                            option: on | Lock
                            option:off | Unlock
</pre>
== keywords ==

Revision as of 08:40, 10 August 2024

choco

choco install ipmicfg

Get IPMI Configuration

Show IPv4 Address and MAC

-m    # Shows IPv4 address and MAC.
ipmicfg-win.exe -m

Help Options

IPMICFG Version 1.32.0 (Build 200910)
Copyright(c) 2020 Super Micro Computer, Inc.
Usage: IPMICFG params (Example: IPMICFG -m 192.168.1.123)
 -help                      Display a list of commands
 -m                         Shows IPv4 address and MAC.
 -m <ip>                    Sets IPv4 address (format: ###.###.###.###).
 -a <mac>                   Sets MAC (format: ##:##:##:##:##:##).
 -k                         Shows Subnet Mask.
 -k <mask>                  Sets Subnet Mask (format: ###.###.###.###).
 -dhcp                      Gets the DHCP status.
 -dhcp on                   Enables the DHCP.
 -dhcp off                  Disables the DHCP.
 -g                         Shows a Gateway IP.
 -g <gateway>               Sets a Gateway IP (format: ###.###.###.###).
 -garp on                   Enables the Gratuitous ARP.
 -garp off                  Disables the Gratuitous ARP.
 -r                         Performs a BMC cold reset.
                            Detects if a BMC reset was successfully performed
                             on the IPMI device, use -d after -r.
 -fd <option>               Resets to the factory defaults without preserving
                             configurations.
                            option:  1 | Preserves User configurations
                            option:  2 | Restores to factory default and
                             default password
                            option:  3 | Sets user defaults to ADMIN/ADMIN
 -fdl                       Resets IPMI to the factory default. (Clean LAN).
 -fde                       Resets IPMI to the factory default. (Clean FRU &
                             LAN).
 -d                         Detects if a BMC reset was successfully performed
                             on the IPMI device.
                            Note that this option can be only used after -r,
                             -fd, -fdl or -fde
 -ver                       Gets firmware revision.
 -vlan                      Gets VLAN status.
 -vlan on [VLAN tag]        Enables the VLAN and sets the VLAN tag.
                            If VLAN tag is not given, it uses the previously
                             saved value.
 -vlan off                  Disables the VLAN.
 -selftest                  Checks and reports the basic health status of the
                             BMC.
 -raw                       Sends a RAW IPMI request and prints a response.
                            Format: NetFn/LUN Cmd [Data1 ... DataN]
 -fru info                  Shows information of the FRU inventory area.
 -fru list                  Shows all FRU values.
 -fru cthelp                Shows chassis type code.
 -fru help                  Shows help of FRU Write.
 -fru <field>               Shows FRU field value.
 -fru <field> <value>       Writes FRU.
 -fru backup <file>         Backs up FRU to a file <Binary format>.
 -fru restore <file>        Restores FRU from a file <Binary format>.
 -fru tbackup <file>        Backs up FRU to a file <Text format>.
 -fru trestore <file>       Restores FRU from a file <Text format>.
 -fru ver <v1> <v2>         Gets/Sets the FRU version. (<v1> and <v2> are
                             BCD-format)
 -sel info                  Shows SEL information.
 -sel list                  Shows SEL records.
 -sel del                   Deletes all SEL records.
 -sel raw                   Shows SEL raw data.
 -sdr [full]                Shows SDR records and readings.
 -sdr del <sdr id>          Deletes the SDR record.
 -sdr ver <v1> <v2>         Gets/Sets the SDR version. (<v1> and <v2> are
                             BCD-format)
 -nm nmsdr                  Displays NM SDR.
 -nm seltime                Gets SEL time.
 -nm deviceid               Gets the ID of the ME device.
 -nm reset                  Reboots ME.
 -nm reset2default          Forces ME to reset to default settings.
 -nm updatemode             Forces ME to enter the update mode.
 -nm selftest               Gets self-test results.
 -nm listimagesinfo         Lists ME information of images.
 -nm oemgetpower            OEM Power command for ME.
 -nm oemgettemp             OEM Temp. command for ME.
 -nm pstate                 Gets the maximum allowed CPU P-State.
 -nm tstate                 Gets the maximum allowed CPU T-State.
 -nm cpumemtemp             Gets CPU/memory temperature.
 -nm hostcpudata            Gets the host CPU data.
 -fan                       Gets the fan mode.
 -fan <mode>                Sets the fan mode.
 -pminfo [full]             Displays PMBus health information of power supply.
 -psfruinfo                 Displays FRU health information of power supply.
 -psbbpinfo                 Displays status of the backup battery.
 -autodischarge <module>    Sets auto discharge by days.
  <day>
 -discharge <module>        Manually discharges a battery.
 -user list                 Lists user privileges.
 -user help                 Shows a user privilege code.
 -user add <user id> <name> Adds a user.
  <password> <privilege>
 -user del <user id>        Deletes users.
 -user level <user id>      Updates user privileges.
  <privilege>
 -user setpwd <user id>     Updates a user password.
  <password>
 -conf download <file>      Downloads IPMI configuration to a binary file.
 -conf upload <file>        Uploads IPMI configuration from a binary file.
  <option>                  option: -p | Bypass warning message
 -conf tdownload <file>     Downloads IPMI configuration to a text file.
 -conf tupload <file>       Uploads IPMI configuration from a text file.
  <option>                  option: -p | Bypass warning message
 -clrint                    Clears chassis intrusion.
 -reset <index>             Resets system and forces to boot from the selected
                             device.
 -soft <index>              Initiates a soft-shutdown for OS and forces system
                             to boot from the selected device.
 -ipv6 mode                 Shows the IPv6 mode.
 -ipv6 mode <mode>          Sets the IPv6 mode.
 -ipv6 autoconfig           Shows IPv6 auto configuration.
 -ipv6 autoconfig on        Enables IPv6 auto configuration.
 -ipv6 autoconfig off       Disables IPv6 auto configuration.
 -ipv6 list                 Lists IPv6 static and dynamic addresses.
 -ipv6 duid                 Shows IPv6 DUID.
 -ipv6 dns [ip]             Gets/Sets IPv6 DNS server.
 -ipv6 add <id> <ip>        Adds IPv6 static address.
  <prefix>
 -ipv6 remove <id>          Removes IPv6 static address.
 -ipv6 route                Displays IPv6 static route.
 -ipv6 route on             Enables IPv6 static route.
 -ipv6 route off            Disables IPv6 static route.
 -ipv6 route list           Lists IPv6 static router information.
 -ipv6 route <id> <prefix   Sets IPv6 static router information.
  value> <prefix length>
  <ip>
 -ipv6 route clear <id>     Clears IPv6 static router information.
 -nvme list                 Displays the existing NVME SSD list.
 -nvme info                 Displays NVME SSD information.
 -nvme rescan               Rescans all devices by in-band.
 -nvme insert <aoc> <group> Inserts SSD by out-of-band.
  <slot>
 -nvme locate <HDD name>    Locates SSD. (in-band)
 -nvme locate <aoc> <group> Locates SSD. (out-of-band)
  <slot>
 -nvme stoplocate <HDD      Stops locateing SSD. (in-band)
  name>
 -nvme stoplocate <aoc>     Stops locateing SSD. (out-of-band)
  <group> <slot>
 -nvme remove <HDD name>    Removes NVME device. (in-band)
  [option1] [option2]       option1: 0 | Do eject after remove (Default)
                            option1: 1 | Do not eject after remove
                            option2:-p | Bypass warning message
 -nvme remove <aoc> <group> Removes NVME device. (out-of-band)
  <slot> [option]           option: -p | Bypass warning message
 -nvme smartdata [HDD name] NVME S.M.A.R.T data.
 -tas info                  Gets TAS information.
 -tas pause                 Pauses a TAS service.
 -tas resume                Resumes a TAS service.
 -tas refresh               Triggers TAS to recollect data.
 -tas clear                 Clears collected TAS data in BMC.
 -tas period <sec>          Sets the time length of a TAS update <limit 5 to 60
                             sec>.
 -tas exec <cmd>            Executes a user's specified command.
 -tp info                   Gets MCU information.
 -tp info <type>            Gets information of MCU type. (type: 1 - 3)
 -tp nodeid                 Gets a node ID.
 -summary                   Displays FW and BIOS information.
 -hostname [value]          Gets/Sets a host name.
 -dcmi cap                  Lists information of DCMI capabilities.
 -dcmi power                Gets the DCMI power readings.
 -dcmi ctl [value]          Gets/Sets the DCMI management controller ID string.
 -mel list                  Shows BMC maintenance event log.
 -mel download <file>       Downloads a BMC maintenance event log to a file.
 -mel clear                 Clears a BMC maintenance event log.
 -addrptl [option]          Gets/Sets IP address protocol.
                            option:  1 | IPv4
                            option:  2 | IPv6
                            option:  3 | Dual
 -lockdown [option]         Checks the system's status mode or puts the system
                             in lockdown mode.
                            option: on | Lock
                            option:off | Unlock

keywords