Direct Path Profile Manager Direct Path Profile Manager Create

Create a DirectPath profile from the specified CreateSpec.

Since: vSphere API Release 9.0.0.0

Required privileges: DirectPathProfileManager.Manage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/DirectPathProfileManager/{moId}/DirectPathProfileManagerCreate

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case DirectPathProfileManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Request Body

DirectPathProfileManagerCreateRequestType of type(s) application/json

Required

Show optional properties

{
    "spec": {
        "name": "string",
        "deviceConfig": {}
    }
}

{
    "spec": {
        "_typeName": "string",
        "name": "string",
        "description": "string",
        "deviceConfig": {
            "_typeName": "string"
        }
    }
}

object

spec

Required

Specification describing the parameters used for creating a DirectPath profile.

Since: vSphere API Release 9.0.0.0

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Unique identifier of the DirectPath profile created.

Returns string of type(s) application/json

Operation doesn't return any data structure

500

AlreadyExists: If a DirectPath profile with the attributes in the createSpec already exists in the target vCenter. There cannot be two DirectPath profiles with the same name or the same device details.

InvalidArgument: If the spec argument does not meet the constraints specified in DirectPathProfileManagerCreateSpec.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"spec":"object"}' https://{api_host}/sdk/vim25/{release}/DirectPathProfileManager/{moId}/DirectPathProfileManagerCreate

Availability

Added in vSphere API Release 9.0.0.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations