clc.group
index
/Users//clc_git/src/clc/group.py

Group related functions.
 
These group related functions generally align one-for-one with published API calls categorized in the group category
 
API v1 - https://t3n.zendesk.com/forums/20568588-Group
API v2 - https://t3n.zendesk.com/forums/21013480-Groups

 
Modules
       
clc

 
Classes
       
Group

 
class Group
     Static methods defined here:
Archive(group, alias=None, location=None)
Archives the Hardware Group along with all child groups and servers.
 
https://t3n.zendesk.com/entries/21004506-Archive-Hardware-Group
 
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
:param group: group name
Create(group, parent=None, description='', alias=None, location=None)
Creates a new group
 
https://t3n.zendesk.com/entries/20979861-Create-Hardware-Group
 
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
:param parent: groups can be nested - name of parent group.  If None will be a toplevel group in the datacenter
:param descrption: optional group description
Delete(group, alias=None, location=None)
Deletes the Hardware Group along with all child groups and servers.
 
https://t3n.zendesk.com/entries/20999933-Delete-Hardware-Group
 
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
:param group: group name
GetGroupID(group, alias=None, location=None)
Given a group name return the unique group ID.
 
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
:param group: group name
GetGroups(location=None, alias=None)
Return all of alias' groups in the given location.
 
https://t3n.zendesk.com/entries/20979826-Get-Groups
 
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
NameGroups(data_arr, id_key)
Get group name associated with ID.
 
TODO - not yet implemented
Pause(group, alias=None, location=None)
Pauses the Hardware Group along with all child groups and servers.
 
https://t3n.zendesk.com/entries/20996052-Pause-Hardware-Group
 
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
:param group: group name
Poweron(group, alias=None, location=None)
Powers on the Hardware Group along with all child groups and servers.
 
https://t3n.zendesk.com/entries/20996102-Power-On-Hardware-Group
 
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
:param group: group name