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

Blueprint related functions.
 
These Blueprint related functions generally align one-for-one with published API calls categorized in the Blueprint category
 
API v1 - https://t3n.zendesk.com/forums/20242326-Blueprint
API v2 - n/a

 
Modules
       
clc
curses
ftplib
operator
os
re
urlparse

 
Classes
       
Blueprint

 
class Blueprint
     Static methods defined here:
GetAllPackages(classification)
Gets a list of all Blueprint Packages with a given classification.
 
https://t3n.zendesk.com/entries/20411357-Get-Packages
 
:param classification: package type filter (System, Script, Software)
GetAllScriptsPackages()
Returns list of all Script packages.
GetAllSoftwarePackages()
Returns list of all Software packages.
GetAllSystemPackages()
Returns list of all System packages.
GetPackages(classification, visibility)
Gets a list of Blueprint Packages filtered by classification and visibility.
 
https://t3n.zendesk.com/entries/20411357-Get-Packages
 
:param classification: package type filter (System, Script, Software)
:param visibility: package visibility filter (Public, Private, Shared)
GetPendingPackages()
Returns list of packages pending publishing.
GetStatus(request_id, location=None, alias=None, silent=False)
Gets the status of the specified Blueprint deployment.
 
https://t3n.zendesk.com/entries/20561586-Get-Deployment-Status
 
:param request_id: the int ID of the Blueprint Deployment to retrieve status for.
:param alias: short code for a particular account.  If none will use account's default alias
:param location: datacenter where group resides
:param silent: disable status output when executed within CLI runtime
PackagePublish(package, classification, visibility, os)
Publishes a Blueprint Package for use within the Blueprint Designer.
 
https://t3n.zendesk.com/entries/20426453-Publish-Package
 
:param package: path to zip file containing package.manifest and supporting scripts
:param classification: package type (System, Script, Software)
:param visibility: package visibility filter (Public, Private, Shared)
:param os: list of ints containing Operating System template IDs
PackagePublishUI(package, type, visibility)
Publishes a Blueprint Package for use within the Blueprint Designer after interactive OS selection.
 
Interactive selection of one or more operating systems by name.
 
:param package: path to zip file containing package.manifest and supporting scripts
:param classification: package type (System, Script, Software)
:param visibility: package visibility filter (Public, Private, Shared)
PackageUpload(package, ftp_url)
Uploads specified zip package to cloud endpoint.
 
See URL below for description on how to properly create a package:
https://t3n.zendesk.com/entries/20348448-Blueprints-Script-and-Software-Package-Management
 
:param package: path to zip file containing package.manifest and supporting scripts
:param ftp_url: ftp URL including credentials of the form ftp://user:password@hostname

Data and other attributes defined here:
classification_stoi = {'Script': 2, 'Scripts': 2, 'Software': 3, 'System': 1}
visibility_stoi = {'Private': 2, 'Public': 1, 'Shared': 3}