Execute IBPortGuidDiscoveryWorkflow

POST

///v1/workflow/ngc/ib_port_guid_discovery

Discover InfiniBand port GUIDs from UFM and sync them onto the matching Nautobot interfaces.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Request

This endpoint expects an object.

switch_device_idslist of stringsRequired

Identifiers of the InfiniBand switches whose interfaces will be synchronized.

ufm_device_idstringRequired

Identifier of the UFM device used to discover port GUIDs.

dry_runbooleanOptionalDefaults to true

Whether to report changes without updating Nautobot.

Response

Successful Response

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

Errors

422

Unprocessable Entity Error

$	curl -X POST /v1/workflow/ngc/ib_port_guid_discovery \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"switch_device_ids": [
>	"switch-1234abcd5678efgh"
>	],
>	"ufm_device_id": "ufm-device-9876wxyz4321lmno"
>	}'