REST API - list
  1. Operations
  2. appliance
  3. configuration
  4. desired state

appliance configuration desired state: list

Returns information about the profile configurations for the appliance that match the appliance.configuration.desired_state.filter_spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/appliance/configuration/desiredstate

?owners={value-1}
&owners={value-2}

Query Parameters:

Name Type Description
bold = required
owners string[] Owners of the profile. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset or empty, profiles from all owners will be returned.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "creation_time" : "2015-01-01T22:13:05.651Z",
        "owner" : "string",
        "profile" : "obj-103",
        "name" : "string",
        "description" : "string",
        "version" : "obj-103"
    },
    {
        "creation_time" : "2015-01-01T22:13:05.651Z",
        "owner" : "string",
        "profile" : "obj-103",
        "name" : "string",
        "description" : "string",
        "version" : "obj-103"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- profile_info[] array of profile details.
-[].profile string Unique Profile identifier. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.configuration.profile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.configuration.profile.
-[].name string Name of the profile. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-[].version string Unique working profile configuration identifier. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.configuration.profile.version. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.configuration.profile.version.
-[].creation_time date_time Creation time of the profile desired configuration. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-[].owner string Owner of the profile, the one who created. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-[].description string Custom description provided by the user. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset description will be empty.

Errors:

HTTP Status Code Type Description
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.