ironicclient.v1.volume_connector module¶
- class ironicclient.v1.volume_connector.VolumeConnectorManager(api)[source]¶
Bases:
ironicclient.common.base.CreateManager
- list(node=None, limit=None, marker=None, sort_key=None, sort_dir=None, detail=False, fields=None, os_ironic_api_version=None, global_request_id=None)[source]¶
Retrieve a list of volume connector.
- Parameters
node – Optional, UUID or name of a node, to get volume connectors for this node only.
marker – Optional, the UUID of a volume connector, eg the last volume connector from a previous result set. Return the next result set.
limit –
- The maximum number of results to return per
request, if:
limit > 0, the maximum number of volume connectors to return.
limit == 0, return the entire list of volume connectors.
limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic’s api.max_limit option).
sort_key – Optional, field used for sorting.
sort_dir – Optional, direction of sorting, either ‘asc’ (the default) or ‘desc’.
detail – Optional, boolean whether to return detailed information about volume connectors.
fields – Optional, a list with a specified set of fields of the resource to be returned. Can not be used when ‘detail’ is set.
os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.
global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.
- Returns
A list of volume connectors.
- resource_class¶