kwatee :: api :: Session :: Class Session

Class Session

Wrapper to Kwatee RESTful Json API

Instance Methods
 
__init__(self, connectionUrl)
Establishes an authenticated session to the kwatee host
 
isConnected(self)
Returns: True if the session is connected False otherwise
 
close(self)
Cleanly disposes of the session
 
getArtifacts(self)
Retrieves the list of artifacts in the repository
 
getArtifact(self, artifactName)
Retrieves an artifact's properties
 
updateArtifact(self, artifactName, artifactProperties)
Updates an artifact's properties
 
createArtifact(self, artifactName, artifactProperties=None)
Creates a new artifact and optionally set additional properties
 
deleteArtifact(self, artifactName)
Deletes an artifact
 
getVersion(self, artifactName, versionName)
Retrieves the properties of an artifact's version
 
updateVersion(self, artifactName, versionName, versionProperties)
Updates an artifact's version properties
 
createVersion(self, artifactName, versionName, versionProperties=None)
Creates a version in an artifact and optionally set additional properties
 
duplicateVersion(self, artifactName, versionName, duplicateFrom, versionProperties=None)
Duplicates an existing version and optionally set additional properties
 
deleteVersion(self, artifactName, versionName)
Deletes an artifact's version
 
uploadArtifactPackagePost(self, artifactName, versionName, uploadFile, deleteOverlays=False)
Uploads a package (multipart content) to an artifact's version.
 
uploadArtifactPackageUrl(self, artifactName, versionName, uploadUrl, deleteOverlays=False)
Uploads a package from a url (could be file://..) to an artifact's version.
 
getArtifactPackageFiles(self, artifactName, versionName, path=None)
Retrieves the files present in a version's package at a given relative path
 
getArtifactSpecialFiles(self, artifactName, versionName)
Retrieves all the special files (overlays, with variables, with custom flags) within the package
 
updateArtifactPackageFileProperties(self, artifactName, versionName, path, fileProperties)
Update custom flags (ignoreIdenty, dontDelete, ...) of a file within a package
 
downloadArtifactPackageFile(self, artifactName, versionName, path, downloadFile)
Downloads a file within the package in the specified location
 
uploadArtifactPackageOverlayPost(self, artifactName, versionName, path, uploadFile)
Uploads (Http Post) an overlay at a relative path within the package
 
uploadArtifactPackageOverlayUrl(self, artifactName, versionName, path, uploadUrl)
Uploads (from URL) an overlay at a relative path within the package
 
deleteArtifactPackageOverlay(self, artifactName, versionName, overlayPath)
Deletes an existing version overlay
 
getArtifactVariables(self, artifactName, versionName)
Retrieves the list of version variables
 
setArtifactVariables(self, artifactName, versionName, variables)
Sets version variables
 
importActifactsBundlePost(self, bundleFile)
Uploads (Http Post) an artifacts bundle into the repository
 
importActifactsBundleUrl(self, bundleUrl)
Uploads (from URL) an artifacts bundle into the repository
 
getServers(self)
Retrieves the list of servers in the repository
 
getServer(self, serverName)
Retrieves the properties of a server
 
updateServer(self, serverName, serverProperties)
Updates the properties of a server
 
createServer(self, serverName, serverProperties=None)
Creates a new server and optionally sets additional properties
 
duplicateServer(self, serverName, duplicateFrom, serverProperties=None)
Duplicates an existing server and optionally set additional properties
 
deleteServer(self, serverName)
Deletes a server
 
serverDiagnostics(self, serverName, properties)
Tests a connection to the server and returns an array of server capabilities
 
getEnvironments(self)
Retrieves the list of environments in the repository
 
getEnvironment(self, environmentName)
Retrieves an environment's properties
 
updateEnvironment(self, environmentName, environmentProperties)
Updates the environment with new properties
 
createEnvironment(self, environmentName, environmentProperties=None)
Creates a new environment and optionally sets additional properties
 
duplicateEnvironment(self, environmentName, duplicateFrom, environmentProperties=None)
Duplicates an existing environment and optionally set additional properties Note that only the snapshot environment is included in a duplicate operation
 
deleteEnvironment(self, environmentName)
Deletes an environment
 
getRelease(self, environmentName, releaseName=None)
Retrieve an environment's release properties
 
updateRelease(self, environmentName, releaseName, releaseProperties)
Updates a release with new properties
 
tagRelease(self, environmentName, releaseName, releaseProperties=None)
Tags a release and optionally sets additional properties (e.g.
 
reeditRelease(self, environmentName, releaseName)
Reedits a previously tagged release
 
deleteRelease(self, environmentName, releaseName=None)
Deletes a release
 
getEffectiveReleaseArtifacts(self, environmentName, releaseName=None)
Retrieves the effective release artifacts (resolves defaultVersions/serverVersions)
 
setReleaseArtifactActiveVersion(self, environmentName, releaseName, artifactName, versionName, serverName=None)
Sets the active version (default of server-specific) of a release artifact
 
getReleasePackageFiles(self, environmentName, releaseName, artifactName, serverName=None, path=None)
Retrieves the files present in an environment artifact at a given relative path within the release artifact package
 
getReleaseSpecialFiles(self, environmentName, releaseName, artifactName, serverName=None)
Retrieves all the special files (overlays, with variables, with custom flags) within the release artifact package
 
updateReleasePackageFileProperties(self, environmentName, releaseName, artifactName, serverName, path, fileProperties)
Update custom flags (ignoreIdenty, dontDelete, ...) of a file within a release artifact package
 
downloadReleasePackageFile(self, environmentName, releaseName, artifactName, serverName, path, downloadFile)
Downloads a file within the release artifact package in the specified location
 
uploadReleasePackageOverlayPost(self, environmentName, releaseName, artifactName, serverName, path, uploadFile)
Uploads (Http Post) an overlay at a relative path within the release artifact package
 
uploadReleasePackageOverlayUrl(self, environmentName, releaseName, artifactName, serverName, path, uploadUrl)
Uploads (from URL) an overlay at a relative path within the release artifact package
 
deleteReleasePackageOverlay(self, environmentName, releaseName, artifactName, serverName, path)
Deletea an existing release artifact package overlay
 
getReleaseVariables(self, environmentName, releaseName=None)
Retrieves the list of release variables
 
setReleaseVariables(self, environmentName, releaseName, variables)
Sets release variables
 
getDeployments(self)
Retrieves the list of deployments
 
getDeployment(self, environmentName, releaseName=None)
Retrieves the deployment properties
 
downloadLightweightInstaller(self, environmentName, releaseName, downloadFile)
Downloads a self-contained command-line installer (to install one server at a time) in the specified location
 
downloadInstaller(self, environmentName, releaseName, downloadFile)
Downloads an installer in the specified location
 
manageDeploy(self, environmentName, releaseName=None, serverName=None, artifactName=None)
Initiates a deploy operation
 
manageUndeploy(self, environmentName, releaseName=None, serverName=None, artifactName=None, forceUndeploy=False)
Initiates an undeploy operation
 
manageCheckIntegrity(self, environmentName, releaseName=None, serverName=None, artifactName=None)
Initiates an check integrity operation
 
manageStart(self, environmentName, releaseName=None, serverName=None, artifactName=None)
Initiates a start executables operation
 
manageStop(self, environmentName, releaseName=None, serverName=None, artifactName=None)
Initiates a stop executables operation
 
manageStatus(self, environmentName, releaseName=None, serverName=None, artifactName=None)
Initiates a status executables operation
 
getOngoingOperation(self)
Retrieves an ongoing deployment operation
 
getOperationStatus(self, ref)
Returns: 200 if successfully completed, 204 if the operation is in progress, 410 if gone and 400 in case of error
 
getOperationProgress(self, ref)
Retrieves the progress of a deployment operation
 
getProgressMessages(self, ref, serverName, artifactName=None)
Retrieves the details of a deployment operation for a given server and or artifact
 
manageCancel(self, ref, dontClear=False)
Cancels an ongoing operation
 
sendCredentials(self, environmentName, serverName, sameForAllServers=False, credentials=None)
Supply server credentials without storing them in kwatee
 
getInfoContext(self)
Retrieves kwatee information (version, ...)
 
getInfoPlatforms(self)
Retrieves the available platforms (operating systems)
 
getInfoConduitTypes(self)
Retrieves the available conduit types (ssh, ftp, ...)
 
getInfoServerPoolTypes(self)
Retrieves the available server pool types (ec2, ...)
 
getLastStatus(self)
Returns: the status of the last call
Method Details

__init__(self, connectionUrl)
(Constructor)

 

Establishes an authenticated session to the kwatee host

Parameters:
  • connectionUrl - a url of the format http://user:password@host:port/kwatee for instance: http://admin:password@localhost:8080/kwatee

isConnected(self)

 
Returns:
True if the session is connected False otherwise

getArtifacts(self)

 

Retrieves the list of artifacts in the repository

Returns:
an array of artifacts

getArtifact(self, artifactName)

 

Retrieves an artifact's properties

Parameters:
  • artifactName - the name of an artifact
Returns:
the artifact's properties

updateArtifact(self, artifactName, artifactProperties)

 

Updates an artifact's properties

Parameters:
  • artifactName - the name of an artifact
  • artifactProperties - the artifact's properties to update

createArtifact(self, artifactName, artifactProperties=None)

 

Creates a new artifact and optionally set additional properties

Parameters:
  • artifactName - the name of the artifact to create
  • artifactProperties - the artifact properties to set or None

deleteArtifact(self, artifactName)

 

Deletes an artifact

Parameters:
  • artifactName - the name of an artifact

getVersion(self, artifactName, versionName)

 

Retrieves the properties of an artifact's version

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
Returns:
the version's properties

updateVersion(self, artifactName, versionName, versionProperties)

 

Updates an artifact's version properties

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • versionProperties - the version properties to update (plain string JSON)

createVersion(self, artifactName, versionName, versionProperties=None)

 

Creates a version in an artifact and optionally set additional properties

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of the version to create
  • versionProperties - the version properties to set or None

duplicateVersion(self, artifactName, versionName, duplicateFrom, versionProperties=None)

 

Duplicates an existing version and optionally set additional properties

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version to create
  • duplicateFrom - name of the version (within same artifact) to duplicate
  • versionProperties - the version properties to set or None

deleteVersion(self, artifactName, versionName)

 

Deletes an artifact's version

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version

uploadArtifactPackagePost(self, artifactName, versionName, uploadFile, deleteOverlays=False)

 

Uploads a package (multipart content) to an artifact's version. Replaces whatever existing package there is but retains previously uploaded overlays unless deleteOverlays=True

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • uploadFile - package file path to upload
  • deleteOverlays - if False, preserves existing overlays

uploadArtifactPackageUrl(self, artifactName, versionName, uploadUrl, deleteOverlays=False)

 

Uploads a package from a url (could be file://..) to an artifact's version. Replaces whatever existing package there is but retains previously uploaded overlays unless deleteOverlays=True

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • uploadUrl - package url to upload
  • deleteOverlays - if False, preserves existing overlays

getArtifactPackageFiles(self, artifactName, versionName, path=None)

 

Retrieves the files present in a version's package at a given relative path

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • path - the relative path of the directory to list within package (None for root of package listing)
Returns:
the files present in a package at a given relative path as as array

getArtifactSpecialFiles(self, artifactName, versionName)

 

Retrieves all the special files (overlays, with variables, with custom flags) within the package

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
Returns:
all the special files (overlays, with variables, with custom flags) within the package as an array

updateArtifactPackageFileProperties(self, artifactName, versionName, path, fileProperties)

 

Update custom flags (ignoreIdenty, dontDelete, ...) of a file within a package

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • path - the relative path of the file within the package
  • fileProperties - the file's properties to update

downloadArtifactPackageFile(self, artifactName, versionName, path, downloadFile)

 

Downloads a file within the package in the specified location

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • path - the relative path of the file within the package
  • downloadFile - the location to store the result into

uploadArtifactPackageOverlayPost(self, artifactName, versionName, path, uploadFile)

 

Uploads (Http Post) an overlay at a relative path within the package

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • path - the relative path of the overlay directory within the package (or None for root)
  • uploadFile - the path to the file to upload

uploadArtifactPackageOverlayUrl(self, artifactName, versionName, path, uploadUrl)

 

Uploads (from URL) an overlay at a relative path within the package

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • path - the relative path of the overlay directory within the package
  • uploadUrl - the url to a file (can be file:///) to upload

deleteArtifactPackageOverlay(self, artifactName, versionName, overlayPath)

 

Deletes an existing version overlay

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • overlayPath - the relative path of the file within the package

getArtifactVariables(self, artifactName, versionName)

 

Retrieves the list of version variables

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
Returns:
an array of version variables

setArtifactVariables(self, artifactName, versionName, variables)

 

Sets version variables

Parameters:
  • artifactName - the name of the version's artifact
  • versionName - the name of a version
  • variables - array of variables

importActifactsBundlePost(self, bundleFile)

 

Uploads (Http Post) an artifacts bundle into the repository

Parameters:
  • bundleFile - the artifacts bundle to import

importActifactsBundleUrl(self, bundleUrl)

 

Uploads (from URL) an artifacts bundle into the repository

Parameters:
  • bundleUrl - the url to an artifacts bundle (can be file:///) to import

getServers(self)

 

Retrieves the list of servers in the repository

Returns:
an array of servers

getServer(self, serverName)

 

Retrieves the properties of a server

Parameters:
  • serverName - the name of the server
Returns:
the server's properties

updateServer(self, serverName, serverProperties)

 

Updates the properties of a server

Parameters:
  • serverName - the name of the server
  • serverProperties - the server properties to update

createServer(self, serverName, serverProperties=None)

 

Creates a new server and optionally sets additional properties

Parameters:
  • serverName - the name of the server to create
  • serverProperties - the server properties to set or None

duplicateServer(self, serverName, duplicateFrom, serverProperties=None)

 

Duplicates an existing server and optionally set additional properties

Parameters:
  • serverName - the name of the server to create
  • duplicateFrom - the name of the server to duplicate
  • serverProperties - the properties to set or None

deleteServer(self, serverName)

 

Deletes a server

Parameters:
  • serverName - the name of the server

serverDiagnostics(self, serverName, properties)

 

Tests a connection to the server and returns an array of server capabilities

Parameters:
  • serverName - the name of the server
  • properties - server properties
Returns:
server capabilities

getEnvironments(self)

 

Retrieves the list of environments in the repository

Returns:
an array of environments

getEnvironment(self, environmentName)

 

Retrieves an environment's properties

Parameters:
  • environmentName - the name of an environment
Returns:
the environment's properties

updateEnvironment(self, environmentName, environmentProperties)

 

Updates the environment with new properties

Parameters:
  • environmentName - the name of an environment
  • environmentProperties - the environment properties to update

createEnvironment(self, environmentName, environmentProperties=None)

 

Creates a new environment and optionally sets additional properties

Parameters:
  • environmentName - the name of the environment to create
  • environmentProperties - the environment properties to set or None

duplicateEnvironment(self, environmentName, duplicateFrom, environmentProperties=None)

 

Duplicates an existing environment and optionally set additional properties Note that only the snapshot environment is included in a duplicate operation

Parameters:
  • environmentName - the name of the environment to create
  • duplicateFrom - the name of the environment to duplicate
  • environmentProperties - the properties to set or None

deleteEnvironment(self, environmentName)

 

Deletes an environment

Parameters:
  • environmentName - the name of an environment

getRelease(self, environmentName, releaseName=None)

 

Retrieve an environment's release properties

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
Returns:
the release properties

updateRelease(self, environmentName, releaseName, releaseProperties)

 

Updates a release with new properties

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • releaseProperties - the release properties to update

tagRelease(self, environmentName, releaseName, releaseProperties=None)

 

Tags a release and optionally sets additional properties (e.g. description)

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of tagged release to create
  • releaseProperties - the release properties to set

reeditRelease(self, environmentName, releaseName)

 

Reedits a previously tagged release

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of existing tagged release

deleteRelease(self, environmentName, releaseName=None)

 

Deletes a release

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release

getEffectiveReleaseArtifacts(self, environmentName, releaseName=None)

 

Retrieves the effective release artifacts (resolves defaultVersions/serverVersions)

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
Returns:
an array of release artifacts

setReleaseArtifactActiveVersion(self, environmentName, releaseName, artifactName, versionName, serverName=None)

 

Sets the active version (default of server-specific) of a release artifact

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • versionName - the active version to be set
  • serverName - None for default active version

getReleasePackageFiles(self, environmentName, releaseName, artifactName, serverName=None, path=None)

 

Retrieves the files present in an environment artifact at a given relative path within the release artifact package

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • serverName - None for list files in default package
  • path - the relative path of the directory to list within package (None for full recursive listing)
Returns:
the files present in a package at a given relative path as an array

getReleaseSpecialFiles(self, environmentName, releaseName, artifactName, serverName=None)

 

Retrieves all the special files (overlays, with variables, with custom flags) within the release artifact package

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • serverName - None for list files in default package
Returns:
all the special files (overlays, with variables, with custom flags) within the package as an array

updateReleasePackageFileProperties(self, environmentName, releaseName, artifactName, serverName, path, fileProperties)

 

Update custom flags (ignoreIdenty, dontDelete, ...) of a file within a release artifact package

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • serverName - None for list files in default package
  • path - the relative path of the file within the package
  • fileProperties - the file properties to update

downloadReleasePackageFile(self, environmentName, releaseName, artifactName, serverName, path, downloadFile)

 

Downloads a file within the release artifact package in the specified location

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • serverName - None for list files in default package
  • path - the relative path of the file within the package
  • downloadFile - the location to store the result into

uploadReleasePackageOverlayPost(self, environmentName, releaseName, artifactName, serverName, path, uploadFile)

 

Uploads (Http Post) an overlay at a relative path within the release artifact package

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • serverName - None for list files in default package
  • path - the relative path of the overlay directory within the package (None for root)
  • uploadFile - the file to upload

uploadReleasePackageOverlayUrl(self, environmentName, releaseName, artifactName, serverName, path, uploadUrl)

 

Uploads (from URL) an overlay at a relative path within the release artifact package

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • serverName - None for list files in default package
  • path - the relative path of the overlay directory within the package (None for root)
  • uploadUrl - the url to the file (can be file:///) to upload

deleteReleasePackageOverlay(self, environmentName, releaseName, artifactName, serverName, path)

 

Deletea an existing release artifact package overlay

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • artifactName - the name of an artifact
  • serverName - None for list files in default package
  • path - the relative path of the file within the package

getReleaseVariables(self, environmentName, releaseName=None)

 

Retrieves the list of release variables

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
Returns:
an array of variables

setReleaseVariables(self, environmentName, releaseName, variables)

 

Sets release variables

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • variables - an array of variables

getDeployments(self)

 

Retrieves the list of deployments

Returns:
an array of deployments

getDeployment(self, environmentName, releaseName=None)

 

Retrieves the deployment properties

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
Returns:
the deployment's properties

downloadLightweightInstaller(self, environmentName, releaseName, downloadFile)

 

Downloads a self-contained command-line installer (to install one server at a time) in the specified location

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • downloadFile - the location to store the result into

downloadInstaller(self, environmentName, releaseName, downloadFile)

 

Downloads an installer in the specified location

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • downloadFile - the location to store the result into

manageDeploy(self, environmentName, releaseName=None, serverName=None, artifactName=None)

 

Initiates a deploy operation

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • serverName - the name of a server or None for all servers in environment
  • artifactName - the name of an artifact or None for all artifacts within server/environment
Returns:
a deployment operation reference

manageUndeploy(self, environmentName, releaseName=None, serverName=None, artifactName=None, forceUndeploy=False)

 

Initiates an undeploy operation

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • serverName - the name of a server or None for all servers in environment
  • artifactName - the name of an artifact or None for all artifacts within server/environment
  • forceUndeploy - if True ignores errors and removes files (default is False)
Returns:
a deployment operation reference

manageCheckIntegrity(self, environmentName, releaseName=None, serverName=None, artifactName=None)

 

Initiates an check integrity operation

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • serverName - the name of a server or None for all servers in environment
  • artifactName - the name of an artifact or None for all artifacts within server/environment
Returns:
a deployment operation reference

manageStart(self, environmentName, releaseName=None, serverName=None, artifactName=None)

 

Initiates a start executables operation

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of a release or None for snapshot release
  • serverName - the name of the server or None for all servers in environment
  • artifactName - the name of an artifact or None for all artifacts within server/environment
Returns:
a deployment operation reference

manageStop(self, environmentName, releaseName=None, serverName=None, artifactName=None)

 

Initiates a stop executables operation

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • serverName - the name of a server or None for all servers in environment
  • artifactName - the name of an artifact or None for all artifacts within server/environment
Returns:
a deployment operation reference

manageStatus(self, environmentName, releaseName=None, serverName=None, artifactName=None)

 

Initiates a status executables operation

Parameters:
  • environmentName - the name of the release's environment
  • releaseName - the name of the release or None for snapshot release
  • serverName - the name of a server or None for all servers in environment
  • artifactName - the name of an artifact or None for all artifacts within server/environment
Returns:
a deployment operation reference

getOngoingOperation(self)

 

Retrieves an ongoing deployment operation

Returns:
a deployment operation reference or None if no operation is in progress

getOperationStatus(self, ref)

 
Returns:
200 if successfully completed, 204 if the operation is in progress, 410 if gone and 400 in case of error

getOperationProgress(self, ref)

 

Retrieves the progress of a deployment operation

Parameters:
  • ref - the reference of an ongoing deployment operation
Returns:
the properties of the deployment operation

getProgressMessages(self, ref, serverName, artifactName=None)

 

Retrieves the details of a deployment operation for a given server and or artifact

Parameters:
  • ref - the reference of an ongoing deployment operation
  • serverName - the name of the server for which info is requested
  • artifactName - the name of an artifact for which info is requested. If None, server-wide information is returned
Returns:
the operation details

manageCancel(self, ref, dontClear=False)

 

Cancels an ongoing operation

Parameters:
  • ref - the reference of an ongoing deployment operation
  • dontClear - if True the status is kept active

sendCredentials(self, environmentName, serverName, sameForAllServers=False, credentials=None)

 

Supply server credentials without storing them in kwatee

Parameters:
  • environmentName - the name of an environment
  • serverName - the name of the server
  • sameForAllServers - if True, these same credentials will be applied to all servers that need it.
  • credentials - the optional credentials

getInfoContext(self)

 

Retrieves kwatee information (version, ...)

Returns:
kwatee properties

getInfoPlatforms(self)

 

Retrieves the available platforms (operating systems)

Returns:
an array of platforms

getInfoConduitTypes(self)

 

Retrieves the available conduit types (ssh, ftp, ...)

Returns:
an array of conduit types

getInfoServerPoolTypes(self)

 

Retrieves the available server pool types (ec2, ...)

Returns:
an array of server pool types

getLastStatus(self)

 
Returns:
the status of the last call