$schema: http://support.riverbed.com/apis/service_def/2.2
description: Exposes state and configuration for system IPMI/BMC access
id: http://support.riverbed.com/apis/npm.ipmi/1.0
name: npm.ipmi
provider: riverbed
resources:
  authentication:
    additionalProperties: false
    description: Configure IPMI authentication details
    links:
      get:
        method: GET
        response: {$ref: '#/resources/authentication'}
      self: {path: $/authentication}
      set:
        method: PUT
        request: {$ref: '#/resources/authentication'}
        response: {$ref: '#/resources/authentication'}
    properties:
      new_password: {description: New root password to set, type: string}
    required: []
    type: object
  configuration:
    additionalProperties: false
    description: 'Report on or change the configuration of IPMI LAN networking

      '
    links:
      get:
        method: GET
        response: {$ref: '#/resources/configuration'}
      self: {path: $/configuration}
      set:
        method: PUT
        request: {$ref: '#/resources/configuration'}
        response: {$ref: '#/resources/configuration'}
    properties:
      enabled: {description: 'If false, IPMI networking is disabled', type: boolean}
      gateway: {description: '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.

          ', type: string}
      ipaddr: {description: '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.

          ', type: string}
      netmask: {description: '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.

          ', type: string}
      use_dhcp: {description: 'If true, use DHCP for addressing, otherwise provide
          static addressing', type: boolean}
    required: [enabled]
    type: object
  state:
    additionalProperties: false
    description: 'Reports the current state of IPMI networking, including interface
      MAC address and current IPv4 details, whether configured statically or via DHCP.

      '
    links:
      get:
        method: GET
        response: {$ref: '#/resources/state'}
      self: {path: $/state}
    properties:
      gateway: {description: IPv4 gateway configured on the IPMI interface, type: string}
      ipaddr: {description: IPv4 address configured on the IPMI interface, type: string}
      mac: {description: MAC address of the IPMI interface, readOnly: true, type: string}
      netmask: {description: IPv4 netmask configured on the IPMI interface, type: string}
      use_dhcp: {description: 'If true, DHCP will be used for addressing', type: boolean}
    required: [use_dhcp, ipaddr, netmask, gateway, mac]
    type: object
title: IPMI Configuration Service
version: '1.0'