IPMI LAN
Basic Operations
Basic operations of List and Set are available.
List IPMI LAN settings
Gets the current IPMI LAN Settings.
Request Object
+ URL /api/v2/ipmi/lan + Method GET + Headers Content-Type: application/json token: ThisIsNotARealTokenGenerateYourOwnToken + Body {}
Response Object
Sending this should return an object with relevant IPMI Settings such as: ip_address, default_gateway_ip, etc.
+ Headers X-Powered-By: OpenDrives Access-Control-Allow-Origin: * Content-Type: application/json; charset=utf-8 + Body { "set_in_progress": "Set Complete", "auth_type_support": "NONE MD2 MD5 PASSWORD", "auth_type_enable": "Callback : MD2 MD5 PASSWORD, User : MD2 MD5 PASSWORD, Operator : MD2 MD5 PASSWORD, Admin : MD2 MD5 PASSWORD, OEM : MD2 MD5 PASSWORD", "ip_address_source": "DHCP Address", "ip_address": "192.168.7.65", "subnet_mask": "255.255.255.0", "mac_address": "0c:c4:7a:8b:bc:7a", "snmp_community_string": "public", "ip_header": "TTL=0x00 Flags=0x00 Precedence=0x00 TOS=0x00", "bmc_arp_control": "ARP Responses Enabled, Gratuitous ARP Disabled", "default_gateway_ip": "192.168.7.1", "default_gateway_mac": "00:00:00:00:00:00", "backup_gateway_ip": "0.0.0.0", "backup_gateway_mac": "00:00:00:00:00:00", "802.1q_vlan_id": "Disabled", "802.1q_vlan_priority": "0", "rmcp+_cipher_suites": "1,2,3,6,7,8,11,12", "cipher_suite_priv_max": "XaaaXXaaaXXaaXX, X=Cipher Suite Unused, c=CALLBACK, u=USER, o=OPERATOR, a=ADMIN, O=OEM", "bad_password_threshold": "Not Available" }
Set IPMI LAN Settings
Updates the system’s IPMI LAN Settings. Accepts a command
and setting
property in the body of the request. These properties are required. Optionally, a channel
property may be provided as well.
Disclaimer
These settings are what allow you to access your system’s IPMI. Setting them incorrectly could result in an inaccessible IPMI. So be careful and understand your network and needs before making changes.
Request Object
+ URL /api/v2/ipmi/lan/set + Method POST + Parameters command (string, required, Body) - The command to run on ipmitool setting (string, required, Body) - The setting to follow the command to run on ipmitool channel ([string, number], optional, Body) - The chanel of the ipmitool to set on + Headers Content-Type: application/json token: ThisIsNotARealTokenGenerateYourOwnToken + Body { "command": "ipaddr", "setting": "192.168.7.31" }
Response Object
Sending this should return a valid success message
+ Headers X-Powered-By: OpenDrives Access-Control-Allow-Origin: * Content-Type: application/json; charset=utf-8 + Body { "success": "Setting LAN IP Address to 192.168.7.31" }
Valid Commands
Here is a table of the available commands for configuring ipmi lan settings.
Command | Description | Parameters | Parameter Options | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ipaddr |
Set the IP address for this channel. |
<x.x.x.x> |
N/a |
||||||||||||||
netmask |
Set the netmask for this channel. |
<x.x.x.x> |
N/a |
||||||||||||||
macaddr |
Set the MAC address for this channel. |
<xx:xx:xx:xx:xx:xx> |
N/a |
||||||||||||||
defgw ipaddr |
Set the default gateway IP address. |
<x.x.x.x> |
N/a |
||||||||||||||
defgw macaddr |
Set the default gateway MAC address. |
<xx:xx:xx:xx:xx:xx> |
N/a |
||||||||||||||
bakgw ipaddr |
Set the backup gateway IP address. |
<x.x.x.x> |
N/a |
||||||||||||||
bakgw macaddr |
Set the backup gateway MAC address. |
<xx:xx:xx:xx:xx:xx> |
N/a |
||||||||||||||
password |
Set the null user password. |
<pass> |
N/a |
||||||||||||||
snmp |
Set the SNMP community string. |
<community string> |
N/a |
||||||||||||||
user |
Enable user access mode for userid 1 |
N/a |
N/a |
||||||||||||||
access |
Set LAN channel access mode. |
<on/off> |
N/a |
||||||||||||||
alert |
Enable or disable PEF alerting for this channel. |
<on/off> |
N/a |
||||||||||||||
ipsrc |
Set the IP address source |
<source> |
|
||||||||||||||
arp respond |
Set BMC generated ARP responses. |
<on/off> |
N/a |
||||||||||||||
arp generate |
Set BMC generated gratuitous ARPs. |
<on/off> |
N/a |
||||||||||||||
arp interval |
Set BMC generated gratuitous ARP interval. |
<seconds> |
N/a |
||||||||||||||
vlan id |
Disable VLAN operation or enable VLAN and set the ID. |
<off/id> |
|
||||||||||||||
vlan priority |
Set the priority associated with VLAN frames. |
<priority> |
|
||||||||||||||
auth |
Set the valid authtypes for a given auth level. |
<level,…> <type,…> |
|
||||||||||||||
cipher_privs |
Correlates cipher suite numbers with the maximum privilege level that is allowed to use it. |
<privlist> |
Privlist must be 15 characters in length. Each character represents a privilege level and the character position identifies the cipher suite number. i.e, the first character represents cipher suite 0, the second represents cipher suite 1, and so on. For example, to set maximum privilege for cipher suite 0 to USER and suite 1 to ADMIN, the privlist would be uaXXXXXXXXXXXXX
|
||||||||||||||
bad_pass_thresh |
Sets the Bad Password Threshold. |
<thresh_num> <1/0> <reset_interval> <lockout_interval> |
|