# ironicclient.v1.volume_connector module

class `ironicclient.v1.volume_connector.``VolumeConnector`(manager, info, loaded=False)

  Bases: `ironicclient.common.base.Resource`

class `ironicclient.v1.volume_connector.``VolumeConnectorManager`(api)

  Bases: `ironicclient.common.base.CreateManager`

  `delete`(volume_connector_id)
  `get`(volume_connector_id, fields=None)
  `list`(node=None, limit=None, marker=None, sort_key=None, sort_dir=None, detail=False, fields=None)

    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:
      1. limit > 0, the maximum number of volume connectors to return.
      2. limit == 0, return the entire list of volume connectors.
      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 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.

    Returns: | A list of volume connectors.

  `resource_class`

    alias of `VolumeConnector`

  `update`(volume_connector_id, patch)

this page last updated: 2020-04-10 14:03:55

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug questions?