system ipmi¶
Perform IPMI related operations
ipmi Specification¶
Parameter
Value
Type
operational
Element Name
ipmi
Element URI
/axapi/v3/system/ipmi
Element Attributes
ipmi_attributes
Partition Visibility
shared
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/system/ipmi |
ipmi attributes¶
ip
Description: ip is a JSON Block. Please see below for ip
Type: Object
Reference Object: /axapi/v3/system/ipmi/ip
ipsrc
Description: ipsrc is a JSON Block. Please see below for ipsrc
Type: Object
Reference Object: /axapi/v3/system/ipmi/ipsrc
reset
Description Reset IPMI Controller
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tool
Description: tool is a JSON Block. Please see below for tool
Type: Object
Reference Object: /axapi/v3/system/ipmi/tool
user
Description: user is a JSON Block. Please see below for user
Type: Object
Reference Object: /axapi/v3/system/ipmi/user
ip¶
Specification
Value
Type
object
default-gateway
Description Default gateway address
Type: string
Format: ipv4-address
ipv4-address
Description IP address
Type: string
Format: ipv4-address
ipv4-netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask
ipsrc¶
Specification
Value
Type
object
dhcp
Description IP addr obtained by BMC running DHCP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
static
Description Manually configured static IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user¶
Specification
Value
Type
object
add
Description Add a new IPMI user (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
administrator
Description Full control
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
callback
Description Lowest privilege level
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable
Description Disable an existing IPMI user (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
newname
Description New IPMI User Name
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
newpass
Description New Password
Type: string
Format: password
Maximum Length: 17 characters
Maximum Length: 1 characters
operator
Description Most BMC commands are allowed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description Password
Type: string
Format: password
Maximum Length: 17 characters
Maximum Length: 1 characters
privilege
Description Change an existing IPMI user privilege (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
setname
Description Change User Name (Current IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
setpass
Description Change Password (IPMI User Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
user
Description Only ‘benign’ commands are allowed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tool¶
Specification
Value
Type
object
cmd
Description Command to execute in double quotes
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters