The `magnumclient.v1.mservices` Module

updated: 2017-07-28 14:08

The `magnumclient.v1.mservices` Module¶

class magnumclient.v1.mservices.MService(manager, info, loaded=False)¶: Bases: magnumclient.common.base.Resource

class magnumclient.v1.mservices.MServiceManager(api)¶

list(marker=None, limit=None, sort_key=None, sort_dir=None, detail=False)¶

Retrieve list of magnum services.

Parameters:

Parameters:	marker – Optional, the ID of a magnum service, eg the last services 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 services to return. limit == 0, return the entire list of services. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Magnum API (see Magnum’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 services.
Returns:	A list of services.

marker – Optional, the ID of a magnum service, eg the last services 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 services to return.
2. limit == 0, return the entire list of services.
3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Magnum API (see Magnum’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 services.

Returns:

A list of services.

updated: 2017-07-28 14:08

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