apis » npm.ipmi » 1.0
IPMI Configuration Service v1.0
Created Mar 27, 2024 at 07:04 PM

Resource: authentication

Configure IPMI authentication details

http://{device}/api/npm.ipmi/1.0/authentication
  • JSON
    • {
  "new_password": string
}
    Property Name Type Description Notes
    authentication <object> Configure IPMI authentication details
    authentication.new_password <string> New root password to set Optional;

    authentication: get

    GET http://{device}/api/npm.ipmi/1.0/authentication
    Response Body

    Returns an authentication data object.

    authentication: set

    PUT http://{device}/api/npm.ipmi/1.0/authentication
    Request Body

    Provide an authentication data object.

    Response Body

    Returns an authentication data object.

    Resource: configuration

    Report on or change the configuration of IPMI LAN networking 

    http://{device}/api/npm.ipmi/1.0/configuration
  • JSON
    • {
  "enabled": boolean,
  "gateway": string,
  "ipaddr": string,
  "netmask": string,
  "use_dhcp": boolean
}
    Property Name Type Description Notes
    configuration <object> Report on or change the configuration of IPMI LAN networking Required properties: [enabled];
    configuration.enabled <boolean> If false, IPMI networking is disabled
    configuration.gateway <string> Optional IPv4 gateway to configure on the IPMI interface, ignored when using DHCP. Reported as "0.0.0.0" if no gateway is configured, IPMI is disabled, or DHCP is enabled. Optional;
    configuration.ipaddr <string> IPv4 address to configure on the IPMI interface, ignored when using DHCP Reported as "0.0.0.0" if IPMI is disabled or DHCP is enabled. Optional;
    configuration.netmask <string> IPv4 netmask to configure on the IPMI interface, ignored when using DHCP Reported as "0.0.0.0" if IPMI is disabled or DHCP is enabled. Optional;
    configuration.use_dhcp <boolean> If true, use DHCP for addressing, otherwise provide static addressing Optional;

    configuration: get

    GET http://{device}/api/npm.ipmi/1.0/configuration
    Response Body

    Returns a configuration data object.

    configuration: set

    PUT http://{device}/api/npm.ipmi/1.0/configuration
    Request Body

    Provide a configuration data object.

    Response Body

    Returns a configuration data object.

    Resource: state

    Reports the current state of IPMI networking, including interface MAC address and current IPv4 details, whether configured statically or via DHCP. 

    http://{device}/api/npm.ipmi/1.0/state
  • JSON
    • {
  "gateway": string,
  "ipaddr": string,
  "mac": string,
  "netmask": string,
  "use_dhcp": boolean
}
    Property Name Type Description Notes
    state <object> Reports the current state of IPMI networking, including interface MAC address and current IPv4 details, whether configured statically or via DHCP. Required properties: [use_dhcp, ipaddr, netmask, gateway, mac];
    state.gateway <string> IPv4 gateway configured on the IPMI interface
    state.ipaddr <string> IPv4 address configured on the IPMI interface
    state.mac <string> MAC address of the IPMI interface Read-only;
    state.netmask <string> IPv4 netmask configured on the IPMI interface
    state.use_dhcp <boolean> If true, DHCP will be used for addressing

    state: get

    GET http://{device}/api/npm.ipmi/1.0/state
    Response Body

    Returns a state data object.