hpeOneView.resources.uncategorized package
Submodules
hpeOneView.resources.uncategorized.unmanaged_devices module
- class hpeOneView.resources.uncategorized.unmanaged_devices.UnmanagedDevices(con)[source]
Bases:
object- URI = '/rest/unmanaged-devices'
- add(information, timeout=-1)[source]
Adds an unmanaged device resource based upon the attributes specified. Use this method to create an unmanaged device to represent resources that consume space within a rack, or consume power from a power delivery device but cannot otherwise be represented by the management appliance.
- Parameters
information – Unmanaged Device information
timeout – Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in OneView; it just stops waiting for its completion.
- Returns
Added Unmanaged Device
- Return type
dict
- get(id_or_uri)[source]
Gets a single Unmanaged Device resource based upon its uri or id.
- Parameters
id_or_uri – Can be either the Unmanaged Device id or the uri
- Returns
The Unmanaged Device
- Return type
dict
- get_all(start=0, count=-1, filter='', query='', sort='')[source]
Gets a set of unmanaged device resources according to the specified parameters. Filters can be used to get a specific set of unmanaged devices. With no filters specified, the API returns a potentially paginated list of all the unmanaged device resources subject to start/count/sort parameters.
- Parameters
start – The first item to return, using 0-based indexing. If not specified, the default is 0 - start with the first available item.
count – The number of resources to return. A count of -1 requests all items. The actual number of items in the response might differ from the requested count if the sum of start and count exceeds the total number of items.
filter (list or str) – A general filter/query string to narrow the list of items returned. The default is no filter; all resources are returned.
query – A general query string to narrow the list of resources returned. The default is no query - all resources are returned.
sort – The sort order of the returned data set. By default, the sort order is based on create time with the oldest entry first.
- Returns
Unmanaged Devices
- Return type
list
- get_by(field, value)[source]
Gets all Unmanaged Devices that match the filter The search is case-insensitive
- Parameters
field – field name to filter
value – value to filter
- Returns
Unmanaged Devices
- Return type
dict
- get_environmental_configuration(id_or_uri)[source]
Returns a description of the environmental configuration (supported feature set, calibrated minimum & maximum power, location & dimensions, …) of the resource.
- Parameters
id_or_uri – Can be either the Unmanaged Device id or the uri
- Returns
EnvironmentalConfiguration
- Return type
dict
- remove(resource, force=False, timeout=-1)[source]
Deletes the resource specified.
- Parameters
resource – Dict object to remove
force – If set to true, the operation completes despite any problems with network connectivity or errors on the resource itself. The default is false.
timeout – Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in OneView; it just stops waiting for its completion.
- Returns
operation success
- Return type
bool
- remove_all(filter, force=False, timeout=-1)[source]
Deletes the set of unmanaged-devices according to the specified parameters. A filter is required to identify the set of resources to be deleted.
- Parameters
filter – A general filter/query string to narrow the list of items that will be removed.
force – If set to true, the operation completes despite any problems with network connectivity or errors on the resource itself. The default is false.
timeout – Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in OneView; it just stops waiting for its completion.
- Returns
operation success
- Return type
bool
- update(resource, timeout=-1)[source]
Updates the resource for the specified. The properties that are omitted (not included as part of the the request body) are reset to their respective default values. The id and uuid properties are required and cannot be changed.
- Parameters
resource (dict) – Object to update
timeout – Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in OneView; it just stops waiting for its completion.
- Returns
Updated Unmanaged Devices
- Return type
dict