Host Profile Manager Create Default Profile

Create a default subprofile of a given type (for example, a VirtualSwitchProfile).

After you create the subprofile, you can add it to a configuration specification and update the host profile:

Call the CreateDefaultProfile method.
Create a HostProfileCompleteConfigSpec object.
Copy the existing profile from the host configuration information (HostProfile.config.applyProfile) to the configuration specification.
Add the new subprofile to the configuration specification. For example, if you create a VirtualSwitchProfile, you would add it to the list of virtual switches in the network profile for the configuration specification (NetworkProfile.vswitch[]).
Call HostProfile.UpdateHostProfile to save the new subprofile.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostProfileManager/{moId}/CreateDefaultProfile

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 HostProfileManager/{moId}.

string

release

Required

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

Request Body

CreateDefaultProfileRequestType of type(s) application/json

Required

Show optional properties

{
    "profileType": "string"
}

{
    "profileType": "string",
    "profileTypeName": "string",
    "profile": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

string

profileType

Required

Type of profile to create. The profile types are system-defined (ApplyProfile.ApplyProfile.profileTypeName).

string

profileTypeName

Optional

If specified, the method returns a profile object containing data for the named profile. The type name does not have to be system-defined. A user-defined profile can include various dynamically-defined profiles.

MoRefProfile

profile

Optional

Reference to an instance of the Profile managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Derived subprofile of type profileType.

Returns ApplyProfile of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "enabled": false,
    "policy": [
        {
            "_typeName": "string",
            "id": "string",
            "policyOption": {
                "_typeName": "string",
                "id": "string",
                "parameter": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ]
            }
        }
    ],
    "profileTypeName": "string",
    "profileVersion": "string",
    "property": [
        "ProfileApplyProfileProperty Object"
    ],
    "favorite": false,
    "toBeMerged": false,
    "toReplaceWith": false,
    "toBeDeleted": false,
    "copyEnableStatus": false,
    "hidden": false
}

boolean

enabled

Required

Indicates whether the profile is enabled.

array of ProfilePolicy

policy

Optional

The list of policies comprising the profile.

A ProfilePolicy stores one or more configuration data values in a PolicyOption. The policy option is one of the configuration options from the ProfilePolicyMetadata.ProfilePolicyMetadata.possibleOption list.

string

profileTypeName

Optional

Identifies the profile type.

string

profileVersion

Optional

Profile engine version.

array of ProfileApplyProfileProperty

property

Optional

List of subprofiles for this profile.

This list can change depending on which profile plug-ins are available in the system. Subprofiles can be nested to arbitrary depths to represent host capabilities.

boolean

favorite

Optional

Indicates whether this profile is marked as "favorite".

boolean

toBeMerged

Optional

Indicates whether this profile is marked as to-be-merged.

boolean

toReplaceWith

Optional

Indicates whether the selected array elements, with the current as one of them, replace the profile array in the target host profile.