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.
connector_id
¶The connector_id for this volume connector
created_at
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
extra
¶The metadata for this volume connector
links
¶A list containing a self link and associated volume connector links
node_uuid
¶The UUID of the node this volume connector belongs to
sanitize
(fields=None)[source]¶Removes sensitive and unrequested data.
Will only keep the fields specified in the fields
parameter.
Parameters: | fields (list of str) – list of fields to preserve, or None to preserve them all |
---|
type
¶The type of volume connector
updated_at
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
uuid
¶Unique UUID for this 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.
connectors
¶A list containing volume connector objects
convert_with_links
(rpc_connectors, limit, url=None, fields=None, detail=None, **kwargs)[source]¶created_at
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
next
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
updated_at
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
ironic.api.controllers.v1.volume_connector.
VolumeConnectorPatchType
(**kw)[source]¶Bases: ironic.api.controllers.v1.types.JsonPatchType
op
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
path
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
value
¶Complex type attribute definition.
Example:
class MyComplexType(wsme.types.Base):
optionalvalue = int
mandatoryvalue = wsattr(int, mandatory=True)
named_value = wsattr(int, name='named.value')
After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:
class MyComplexType(wsme.types.Base):
optionalvalue = wsattr(int)
mandatoryvalue = wsattr(int, mandatory=True)
ironic.api.controllers.v1.volume_connector.
VolumeConnectorsController
(node_ident=None)[source]¶Bases: pecan.rest.RestController
REST controller for VolumeConnectors.
delete
(connector_uuid)[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
(node=None, marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, detail=None)[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
(connector_uuid, fields=None)[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. |
invalid_sort_key_list
= ['extra']¶patch
(connector_uuid, patch)[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
(connector)[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.