ironic.api.controllers.v1.volume_target
Module¶ironic.api.controllers.v1.volume_target.
VolumeTarget
(**kwargs)[source]¶Bases: ironic.api.controllers.base.APIBase
API representation of a volume target.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a volume target.
ironic.api.controllers.v1.volume_target.
VolumeTargetCollection
(**kwargs)[source]¶Bases: ironic.api.controllers.v1.collection.Collection
API representation of a collection of volume targets.
ironic.api.controllers.v1.volume_target.
VolumeTargetsController
(node_ident=None)[source]¶Bases: pecan.rest.RestController
REST controller for VolumeTargets.
delete
(*args, **kwargs)[source]¶Delete a volume target.
Parameters: | target_uuid – UUID of a volume target. |
---|---|
Raises: | OperationNotPermitted if accessed with specifying a parent node. |
Raises: | NodeLocked if node is locked by another conductor |
Raises: | NodeNotFound if the node associated with the target does not exist |
Raises: | VolumeTargetNotFound if the volume target cannot be found |
Raises: | InvalidStateRequested If a node associated with the volume target is not powered off. |
get_all
(*args, **kwargs)[source]¶Retrieve a list of volume targets.
Parameters: |
|
---|---|
Returns: | a list of volume targets, or an empty list if no volume target is found. |
Raises: | InvalidParameterValue if sort_key does not exist |
Raises: | InvalidParameterValue if sort key is invalid for sorting. |
Raises: | InvalidParameterValue if both fields and detail are specified. |
get_one
(*args, **kwargs)[source]¶Retrieve information about the given volume target.
Parameters: |
|
---|---|
Returns: | API-serializable volume target object. |
Raises: | OperationNotPermitted if accessed with specifying a parent node. |
Raises: | VolumeTargetNotFound if no volume target with this UUID exists |
patch
(*args, **kwargs)[source]¶Update an existing volume target.
Parameters: |
|
---|---|
Returns: | API-serializable volume target object. |
Raises: | OperationNotPermitted if accessed with specifying a parent node. |
Raises: | PatchError if a given patch can not be applied. |
Raises: | InvalidParameterValue if the volume target’s UUID is being changed |
Raises: | NodeLocked if the node is already locked |
Raises: | NodeNotFound if the node associated with the volume target does not exist |
Raises: | VolumeTargetNotFound if the volume target cannot be found |
Raises: | VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same node ID and boot index values |
Raises: | InvalidUUID if invalid node UUID is passed in the patch. |
Raises: | InvalidStateRequested If a node associated with the volume target is not powered off. |
post
(*args, **kwargs)[source]¶Create a new volume target.
Parameters: | target – a volume target within the request body. |
---|---|
Returns: | API-serializable volume target object. |
Raises: | OperationNotPermitted if accessed with specifying a parent node. |
Raises: | VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same node ID and boot index |
Raises: | VolumeTargetAlreadyExists if a volume target with the same UUID exists |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.