|
__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 |
|
|
|
|
|
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 |
|
|
|
|
|
downloadArtifactPackageFile(self,
artifactName,
versionName,
path,
downloadFile)
Downloads a file within the package in the specified location |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 |
|
|
|
|
|
serverDiagnostics(self,
serverName,
properties)
Tests a connection to the server and returns an array of server
capabilities |
|
|
|
|
|
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 |
|
|
|
|
|
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 |
|
|
|
|
|
|
|
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 |
|
|
|
|
|
getOperationStatus(self,
ref)
Returns:
200 if successfully completed, 204 if the
operation is in progress, 410 if gone and
400 in case of error |
|
|
|
|
|
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 |
|
|
|
|
|
|
|
|
|
|
|
|