ApplyProfile

ApplyProfile
ApplyProfile

The ApplyProfile data object is the base class for all data objects that define profile configuration data.

ApplyProfile defines ESX configuration data storage and it supports recursive profile definition for the profile plug-in architecture.

AllOf
This class requires all of the following:
JSON Example 
{
    "_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": [
        {
            "_typeName": "string",
            "propertyName": "string",
            "array": false,
            "profile": [
                "ApplyProfile 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.

boolean
toBeDeleted
Optional

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

boolean
copyEnableStatus
Optional

Indicates that the member variable enabled of this profile will be copied from source profile to target profiles at host profile composition.

boolean
hidden
Optional

Indicates whether this profile will be displayed or not.

Property Of
Used By
Returned By