Skip to main content

A library for interacting with the ECS 2.x Management API

Project description

Note: ECS is an EMC product, trademarked, copyrighted, etc.

This library follows the ECS API documentation located here.

Using this library is pretty straight forward. ECSMinion can be installed from PyPi:

$ pip install ecsminion

Creating an instance of the ECSMinion class requires the following arguments:

Name Required Default Value Description
username No None The username used to fetch the ECS token
password No None The password used to fetch the ECS token
token No None Pass a token to ECSMinion (username/password are ignored then)
ecs_endpoint Yes None The ECS API endpoint, ex:
token_endpoint Yes None The ECS API endpoint, ex:
verify_ssl No False Whether to check a host’s SSL certificate
token_filename No ecstoken.tkn The filename of the temporary token
token_location No /tmp The location to store the temporary token file
request_timeout No 15.0 Stop waiting for a response after a given number of seconds, this is a decimal value. Ex: 10.0 is ten seconds
cache_token No True Whether to cache the token, by default this is true you should only switch this to false when you want to directly fetch a token for a user

Here is an example that goes through most of the API calls. Please note that some calls take longer to complete than others. Sometimes you may need to set your request_timeout to 60.0.

from ecsminion import ECSMinion, ECSMinionException

    client = ECSMinion(username='ecsadmin@internal',


    # Configuration

    # User Management
        uid='user1', namespace='namespace1'))
    print(client.user_object.get_object_user_info('user1', 'namespace1'))
        uid='user2', namespace='namespace1', tags=['mytag1', 'mytag1']))
        uid='user2', namespace='namespace1'))
    print(client.user_object.lock_object_user('user1', True, 'namespace1'))
    print(client.user_object.get_object_user_lock('user1', 'namespace1'))
    print(client.user_object.lock_object_user('user1', False, 'namespace1'))
    print(client.user_object.get_object_user_lock('user1', 'namespace1'))

except ECSMinionException as ecsminion_ex:
    print('Message: {0}'.format(ecsminion_ex.message))
    print('Status Code Returned: {0}\n'.format(ecsminion_ex.http_status_code))
    print('ECS API Message: {0}'.format(ecsminion_ex.ecs_message))
except Exception as ex:

Running PEP8

There are some example JSON comments in the source code that are over the allowed PEP8 length. You can ignore those by running:

$ pep8 --ignore=E501 .


This software library is released to you under the Apache License 2.0. See LICENSE for more information.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ecsminion, version 0.5.2
Filename, size File type Python version Upload date Hashes
Filename, size ecsminion-0.5.2.tar.gz (11.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page