ironicclient.v1.volume_target module

class ironicclient.v1.volume_target.VolumeTarget(manager, info, loaded=False)

Bases: ironicclient.common.base.Resource

class ironicclient.v1.volume_target.VolumeTargetManager(api)

Bases: ironicclient.common.base.CreateManager

delete(volume_target_id, os_ironic_api_version=None, global_request_id=None)

get(volume_target_id, fields=None, os_ironic_api_version=None, global_request_id=None)

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)

Retrieve a list of volume target.

Parameters

• node – Optional, UUID or name of a node, to get volume targets for this node only.

• marker – Optional, the UUID of a volume target, eg the last volume target from a previous result set. Return the next result set.

• limit –

  The maximum number of results to return per

  request, if:

  1. limit > 0, the maximum number of volume targets to return.

  2. limit == 0, return the entire list of volume targets.

  3. 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 targets.

• 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 targets.

resource_class

alias of ironicclient.v1.volume_target.VolumeTarget

update(volume_target_id, patch, os_ironic_api_version=None, global_request_id=None)