Host Aggregate
1. aggregates(id=None, **query)
Lists host aggregates.
Parameters:
| Name | Type | Description |
|---|---|---|
| id (optional) | String | user id. Provided to get specific aggregate |
| query(optional) | Dict | queries |
Return value: HostAggregate Object or a list
Return value example:
name : newname
availability_zone : nova2
deleted : False
created_at : 2016-08-17T03:24:54.000000
updated_at : 2016-08-18T08:31:38.000000
hosts : [u'testserver']
deleted_at : None
id : 309
metadata : {u'key2': u'value2', u'availability_zone': u'nova2', u'key': u'value', u'everything': u'nothing'}
name : pythonTest
availability_zone : nova
deleted : False
created_at : 2016-08-17T03:27:53.000000
updated_at : None
hosts : []
deleted_at : None
id : 310
metadata : {u'availability_zone': u'nova'}…
- create_aggregate(**attr) Create a host aggregate.
Parameters: attr(Dict)
| Name | Type | Description |
|---|---|---|
| name | String | name |
| availability_zone | String | e.g: “nova” |
refer to openstack API: http://developer.openstack.org/api-ref/compute/
Parameters example:
attr = {'name': 'pythonTest1', 'availability_zone': 'nova'}
Return value: HostAggregate Object
Return value example:
name : pythonTest1
availability_zone : nova
deleted : False
created_at : 2016-08-26T06:34:47.000000
updated_at : None
deleted_at : None
id : 316
3. update_aggregate(aggregate, **attr)
Updates a aggregate.
Parameters:
- aggregate(string): id or Object
- attr(Dict):
Return value: HostAggregate Object
4. delete_aggregate(aggregate)
Delete aggregate.
Parameters: aggregate(string): id or Object
Return value: None on success
5. create_update_aggregate_metadata(aggregate, **meta)
create or replace metadata items, or, create or update metadata item
Parameters: aggregate(String): id or Object
Parameters example:
cloud.compute.create_update_aggregate_metadata(aggregate, everything="nothing")
Return value: HostAggregate Object
Return value example:
name : updatePythonTest11
availability_zone : nova
deleted : False
created_at : 2016-08-26T06:34:47.000000
updated_at : 2016-08-26T06:34:47.000000
hosts : []
deleted_at : None
id : 316
metadata : {u'everything': u'nothing', u'availability_zone': u'nova'}
6. add_host_aggregate(aggregate, host)
add host
Parameters:
- aggregate(String): id or Object
- host(String): host name
Parameters example:
host=”testserver”
Return value: HostAggregate Object
Return value example:
HostAggregate:
name : newname
availability_zone : nova2
deleted : False
created_at : 2016-08-17T03:24:54.000000
updated_at : 2016-08-18T08:31:38.000000
hosts : [u'testserver']
deleted_at : None
id : 309
metadata : {u'key2': u'value2', u'availability_zone': u'nova2', u'key': u'value', u'everything': u'nothing'}
7. remove_host_aggregate(aggregate, host)
add host
Parameters:
- aggregate(String): id or Object
- host(String): host name
Parameters example:
host=”testserver”
Return value: HostAggregate Object
Return value example:
HostAggregate:
name : newname
availability_zone : nova2
deleted : False
created_at : 2016-08-17T03:24:54.000000
updated_at : 2016-08-18T08:31:38.000000
hosts : []
deleted_at : None
id : 309
metadata : {u'key2': u'value2', u'availability_zone': u'nova2', u'key': u'value', u'everything': u'nothing'}