SAN Fabric Pools

POST /storage/fabric/pools/create

Create a SAN fabric pool

Validates the pool, resolves the hosts in its scope, mints the per-pool plugin token and registers the pool in the platform.

Request JSON Object:
  • auth.mode (string)

  • auth.secret (string)

  • auth.target_secret (string)

  • auth.target_username (string)

  • auth.username (string)

  • backend_id (string)

  • cluster_id (string)

  • driver (string) – Driver names a driver that maps existing LUNs; such a pool carries its own backend, so exactly one of BackendID and Driver is set.

  • min_paths (integer)

  • name (string)

  • pod_id (string)

  • portals[].address (string)

  • portals[].ana_group (string)

  • portals[].port (integer)

  • portals[].subsystem_nqn (string)

  • portals[].target_iqn (string)

  • protocol (string)

  • qos[] (integer)

  • scope (string)

  • tags[] (string)

  • target_iqns[] (string)

  • zone_id (string)

Status Codes:
  • 201 Created – {pool: {the pool’s fields and portals, backend_name, effective_state, warnings, redundancy: {portals_used, portals_configured, portals_served, host_paths_min, single_path, single_path_hosts, unused_portals, note}}, health, hosts}

  • 400 Bad Request – Invalid request payload, a portal the backend does not serve (for iSCSI on that target), or CHAP on a driver that does not program it

  • 409 Conflict – Name or storage-tag conflict, a host in scope cannot attach the pool (KF-4013), TARGET_CHOICE_REQUIRED (meta.discovered_targets: [{iqn, portal, tpgt, in_use_by_pool, in_use_by_pool_id}], a target another pool uses carries that pool) or TARGET_IN_USE (every discovered target is already used)

  • 502 Bad Gateway – The platform could not be reached, or KF-5010/KF-5012 the backend’s portals could not be read to check the pool’s against them

  • 503 Service Unavailable – Generic iSCSI: KF-5022 no node in the pool’s scope answered, so no target could be discovered, or the pool using the discovered target changed while it was checked; nothing was created, retry

POST /storage/fabric/pools/delete

Delete a SAN fabric pool

Removes the pool from the platform and deletes its portals, CHAP secret and row. Refused while volumes exist.

Request JSON Object:
  • id (string)

Status Codes:
POST /storage/fabric/pools/drivers/list

List SAN fabric backend drivers

Lists the driver names registered in this build and, per driver, its declared capabilities: whether it programs CHAP (auth) and storage QoS (qos), whether a pool’s portals are held to its listing (lists_portals), and how core reaches the array (management: “ssh” means tls_verify pins the array’s SSH host key, extras.host_key), so a client can tell before it asks. Test-only drivers are never listed.

Status Codes:
  • 200 OK – Driver names and capabilities

Response JSON Object:
  • capabilities (object)

  • default_driver (string) – DefaultDriver is the one a form preselects: comstar when this build has it, else the first listed.

  • drivers[] (string)

POST /storage/fabric/pools/get

Get one SAN fabric pool

Returns the pool with its portals, the hosts resolved into its scope, and its redundancy: the portals its hosts use (configured plus live sessions) next to those the array serves on its targets (read live), the unused ones named, and single_path unless every host in scope reports two or more live paths (a host with no fresh count is judged by the configured portals). warnings says the same in words and names CHAP or QoS the pool keeps that its driver does not enforce. Both are warnings, never a refusal.

Request JSON Object:
  • id (string)

Status Codes:
  • 200 OK – {pool: {the pool’s fields and portals, backend_name, effective_state, warnings, redundancy: {portals_used, portals_configured, portals_served, host_paths_min, single_path, single_path_hosts, unused_portals, note}}, hosts}; redundancy is absent for FC

  • 400 Bad Request – Invalid request payload

  • 404 Not Found – Pool not found

POST /storage/fabric/pools/health

Get the health of a SAN fabric pool

Reports the pool state and the hosts in its scope. Reachability is a placeholder until the host plane reports.

Request JSON Object:
  • id (string)

Status Codes:
POST /storage/fabric/pools/list

List SAN fabric pools

Lists every pool with its portals and backend name, its effective state, its warnings (CHAP or QoS its driver does not enforce, a host on one path) and its redundancy from its portals and its hosts’ live paths; the array’s served portals are read only by pools/get and pools/create, so portals_served is absent here. Never returns tokens or secrets.

Status Codes:
  • 200 OK – {pools: [{the pool’s fields and portals, backend_name, effective_state, warnings, redundancy: {portals_used, portals_configured, host_paths_min, single_path, single_path_hosts, note}}], count}

  • 500 Internal Server Error – Internal server error

POST /storage/fabric/pools/push

Push a SAN fabric pool to its hosts

Re-sends the pool’s desired state to every host in scope and returns the resulting health.

Request JSON Object:
  • id (string)

Status Codes:
POST /storage/fabric/pools/register

Retry the platform registration of a pool

Re-sends a pending pool to the platform with the service token it was created with.

Request JSON Object:
  • id (string)

Status Codes:
POST /storage/fabric/pools/update

Update a SAN fabric pool

Changes the storage tags, min_paths or QoS of an existing pool; a registered pool’s tags are written to the platform first.

Request JSON Object:
  • id (string)

  • min_paths (integer)

  • qos[] (integer)

  • tags[] (string)

Status Codes: