HP OneView REST API Reference

server-profiles
server-profiles.html[10/17/2013 10:35:14 AM]
Note: The filter function allows for both actual and
partial matches of data in the profile. Any requests that
wish to use a wild card match must include a %25 as
illustrated in the example. This is how that character is
encoded for transmission to the appliance.
DELETE Deletes all Server Profile objects from the appliance that match the provided filter. If a filter string is not
provided, then the API will delete all Server Profile objects from the appliance. Filters are supported for the
following profile attributes only - name, description, serialnumber, uuid, mactype, wwntype, serialnumbertype,
status and state.
Parameter Attributes Description
force Optional If set to true, the operation completes even if there are network connectivity
issues or resource errors. The default is false.
query Experimental This parameter is experimental for this release: While generally functional
when used in simple cases, restrictions might be noted in the implementation
description.
If the query is supported, the following is the way it works. A general query string
that narrows the list of resources returned by a multi-resource GET (read) request
and DELETE (delete) request. The default is no query (all resources are
returned). One advantage query has over filter is that it can have embedded
ORs. A single query parameter can do what would take multiple parameters or
multiple GET requests using filter. Use query for more complex queries.
filter Experimental This parameter is experimental for this release: While generally functional
when used in simple cases, restrictions might be noted in the implementation
description.
A general filter/query string that narrows the list of resources returned by a multi-
resource GET (read) request and DELETE (delete) request. The default is no filter
(all resources are returned).
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current
release, this must be set to "X-API-Version:3"
Response Description
TaskResourceV2 TaskResourceV2 object for tracking of the delete operation
to
completion
Response Codes
REST API Response Codes
Examples
Delete all profiles that match the name "Exchange Server":
DELETE https://{appl}/rest/server-profiles?filter=name=
"Exchange Server"
Delete all profiles that have the word "Database" in its
name:
DELETE https://{appl}/rest/server-profiles?filter=
"name matches '%25Database%25'"
Note: The filter function here operates very similar to
the the function defined for GET Server Profiles in it
allows for both actual and partial matches of data in
the profile. Any requests that wish to use a wildcard
match must include a %25 as illustrated in the example.
This is how that character is encoded for transmission