ironic.api.controllers.v1.volume_connector
Module¶ironic.api.controllers.v1.volume_connector.
VolumeConnector
(**kwargs)[source]¶Bases: ironic.api.controllers.base.APIBase
API representation of a volume connector.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a volume connector.
ironic.api.controllers.v1.volume_connector.
VolumeConnectorCollection
(**kwargs)[source]¶Bases: ironic.api.controllers.v1.collection.Collection
API representation of a collection of volume connectors.
ironic.api.controllers.v1.volume_connector.
VolumeConnectorsController
(node_ident=None)[source]¶Bases: pecan.rest.RestController
REST controller for VolumeConnectors.
delete
(*args, **kwargs)[source]¶Delete a volume connector.
Parameters: | connector_uuid – UUID of a volume connector. |
---|---|
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 connector does not exist |
Raises: | VolumeConnectorNotFound if the volume connector cannot be found |
Raises: | InvalidStateRequested If a node associated with the volume connector is not powered off. |
get_all
(*args, **kwargs)[source]¶Retrieve a list of volume connectors.
Parameters: |
|
---|---|
Returns: | a list of volume connectors, or an empty list if no volume connector 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 connector.
Parameters: |
|
---|---|
Returns: | API-serializable volume connector object. |
Raises: | OperationNotPermitted if accessed with specifying a parent node. |
Raises: | VolumeConnectorNotFound if no volume connector exists with the specified UUID. |
patch
(*args, **kwargs)[source]¶Update an existing volume connector.
Parameters: |
|
---|---|
Returns: | API-serializable volume connector object. |
Raises: | OperationNotPermitted if accessed with specifying a parent node. |
Raises: | PatchError if a given patch can not be applied. |
Raises: | VolumeConnectorNotFound if no volume connector exists with the specified UUID. |
Raises: | InvalidParameterValue if the volume connector’s UUID is being changed |
Raises: | NodeLocked if node is locked by another conductor |
Raises: | NodeNotFound if the node associated with the connector does not exist |
Raises: | VolumeConnectorTypeAndIdAlreadyExists if another connector already exists with the same values for type and connector_id fields |
Raises: | InvalidUUID if invalid node UUID is passed in the patch. |
Raises: | InvalidStateRequested If a node associated with the volume connector is not powered off. |
post
(*args, **kwargs)[source]¶Create a new volume connector.
Parameters: | connector – a volume connector within the request body. |
---|---|
Returns: | API-serializable volume connector object. |
Raises: | OperationNotPermitted if accessed with specifying a parent node. |
Raises: | VolumeConnectorTypeAndIdAlreadyExists if a volume connector already exists with the same type and connector_id |
Raises: | VolumeConnectorAlreadyExists if a volume connector with the same UUID already exists |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.