pyrundeck.Rundeck

class documentation

class Rundeck(object): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method abort_execution Undocumented
Method auth Undocumented
Method bulk_delete_executions Undocumented
Method create_token Undocumented
Method delete_execution Undocumented
Method delete_token Undocumented
Method execution_info_by_id Undocumented
Method execution_output_by_id Undocumented
Method execution_state Undocumented
Method get_acl_policy Undocumented
Method get_executions_for_job Undocumented
Method get_job Undocumented
Method get_job_def Undocumented
Method get_job_meta Undocumented
Method get_resource_info Undocumented
Method get_running_jobs This requires API version 32
Method get_token Undocumented
Method list_all_jobs Undocumented
Method list_jobs Undocumented
Method list_jobs_by_group Undocumented
Method list_projects Undocumented
Method list_resources Undocumented
Method list_running_executions Undocumented
Method list_system_acl_policies Undocumented
Method list_tokens Undocumented
Method query_executions Undocumented
Method run_job Undocumented
Method run_job_by_name Undocumented
Method set_active_mode Undocumented
Method set_passive_mode Undocumented
Method system_info Undocumented
Method upload_file This requires API version 19
Instance Variable API_URL Undocumented
Instance Variable api_version Undocumented
Instance Variable auth_cookie Undocumented
Instance Variable password Undocumented
Instance Variable rundeck_url Undocumented
Instance Variable token Undocumented
Instance Variable username Undocumented
Instance Variable verify Undocumented
Method __delete Undocumented
Method __get Undocumented
Method __post Undocumented
Method __request Undocumented
Method _post_file Undocumented
def __init__(self, rundeck_url, token=None, username=None, password=None, api_version=18, verify=True): (source)

Undocumented

def abort_execution(self, exec_id): (source)

Undocumented

def auth(self): (source)

Undocumented

def bulk_delete_executions(self, exec_ids): (source)

Undocumented

def create_token(self, user, roles='*', duration=None): (source)

Undocumented

def delete_execution(self, exec_id): (source)

Undocumented

def delete_token(self, token_id): (source)

Undocumented

def execution_info_by_id(self, exec_id): (source)

Undocumented

def execution_output_by_id(self, exec_id): (source)

Undocumented

def execution_state(self, exec_id): (source)

Undocumented

def get_acl_policy(self, policy): (source)

Undocumented

def get_executions_for_job(self, job_id=None, job_name=None, **kwargs): (source)

Undocumented

def get_job(self, name, project=None): (source)

Undocumented

def get_job_def(self, job_id, format='xml'): (source)

Undocumented

def get_job_meta(self, job_id): (source)

Undocumented

def get_resource_info(self, project, resource): (source)

Undocumented

def get_running_jobs(self, project, job_id=None): (source)

This requires API version 32

def get_token(self, token_id): (source)

Undocumented

def list_all_jobs(self): (source)

Undocumented

def list_jobs(self, project): (source)

Undocumented

def list_jobs_by_group(self, project, groupPath=None): (source)

Undocumented

def list_projects(self): (source)

Undocumented

def list_resources(self, project): (source)

Undocumented

def list_running_executions(self, project): (source)

Undocumented

def list_system_acl_policies(self): (source)

Undocumented

def list_tokens(self, user=None): (source)

Undocumented

def query_executions(self, project, name=None, group=None, status=None, user=None, recent=None, older=None, begin=None, end=None, adhoc=None, max_results=20, offset=0): (source)

Undocumented

def run_job(self, job_id, args=None, options=None, log_level=None, as_user=None, node_filter=None): (source)

Undocumented

def run_job_by_name(self, name, *args, **kwargs): (source)

Undocumented

def set_active_mode(self): (source)

Undocumented

def set_passive_mode(self): (source)

Undocumented

def system_info(self): (source)

Undocumented

def upload_file(self, job_id, option_name, file, params=None): (source)

This requires API version 19

API_URL = (source)

Undocumented

api_version = (source)

Undocumented

auth_cookie = (source)

Undocumented

password = (source)

Undocumented

rundeck_url = (source)

Undocumented

token = (source)

Undocumented

username = (source)

Undocumented

verify = (source)

Undocumented

def __delete(self, url, params=None): (source)

Undocumented

def __get(self, url, params=None, format='json'): (source)

Undocumented

def __post(self, url, params=None, upload_file=None): (source)

Undocumented

def __request(self, method, url, params=None, upload_file=None, format='json'): (source)

Undocumented

def _post_file(self, file_name, file_obj, job_id, option_name, parameters=None): (source)

Undocumented