IB Security Verification REST API

Validates InfiniBand security configurations for UFM deployments, including secured BareMetal Cloud profiles for CSP and NCP environments. The API verifies security-related settings in opensm.conf and gv.cfg (including cloud_profile equivalency to bare_metal_cloud_mode), as well as optional partition/PKey configurations. Findings are returned as categorized Errors, Warnings, and Info entries.

The following operation is supported:

Verify IB Security Configuration

Verify IB Security Configuration

Description

Runs InfiniBand security verification checks and returns findings according to the requested verbosity level.

Request URL

POST /ufmRest/app/ib_security_verification

Request Content-Type

application/json

Status Codes

Code	Description
200	OK
400	BAD_REQUEST

Request Parameters

Name	Type	Default	Description	Mandatory
`verbose`	Integer (`0`, `1`, `2`)	`0`	Controls response verbosity: `0` = Errors only `1` = Errors and Warnings `2` = Errors, Warnings, and Info	Optional
`test_pkey_settings`	Integer (`0`, `1`)	`0`	When set to `1`, also verifies partition/PKey configurations for security issues.	Optional

Request Body Example

{
  "verbose": 2,
  "test_pkey_settings": 1
}

Response

Returns a JSON object containing only the categories applicable to the requested verbosity level.

Each finding includes:

Field	Description
`source`	The configuration file or component where the issue was detected
`description`	Details of the finding and recommended remediation

Response Example (verbose=2, test_pkey_settings=1)

{
  "Errors": [
    {
      "source": "opensm.conf",
      "description": "m_key_protection_level is set to 0; no protection is provided. Value should be 2 for full protection."
    }
  ],
  "Warnings": [
    {
      "source": "gv.cfg",
      "description": "mad_limiter_enabled is set to false. Value should be set to true for improved security."
    },
    {
      "source": "partition configuration",
      "description": "Switch port 0x001234abcd is configured as a full member on the default PKey. Verify that this configuration is intentional."
    }
  ],
  "Info": [
    {
      "source": "gv.cfg",
      "description": "bare_metal_cloud_mode is set to 0, indicating a single-tenant network assumption. If the deployment is multi-tenant, set bare_metal_cloud_mode to 2."
    }
  ]
}

Response Example (verbose=0, default)

{
  "Errors": [
    {
      "source": "opensm.conf",
      "description": "m_key_protection_level is set to 0; no protection is provided. Value should be 2 for full protection."
    }
  ]
}

Last updated: June 03, 2026