createWorkspace
Creates a new workspace. A workspace definition consists of three paths to access the workspace in various ways:
agentDrivePath
agentUncPath
—The agent uses agentUncPath
and agentDrivePath
to compute the drive mapping needed to make agentDrivePath
valid in the step (see examples below).
agentUnixPath
Examples for agentDrivePath
and agentUncPath
:
agentDrivePath | agentUncPath | Result from running a step in "job123" that uses this workspace |
---|---|---|
N:\ |
| The agent maps |
N:\sub1 |
| The agent maps |
N:\sub1 |
| Invalid! No mapping can be deduced from this pair of values. |
C:\ws |
| A local workspace on the agent. No drive mapping is needed. The job step runs in ` c:\ws\job123`. |
C:\ws | Same as if |
You must specify a workspaceName
.
Arguments | Descriptions |
---|---|
workspaceName | The workspace name. Argument type: String |
agentDrivePath | (Optional) Drive-letter-based path used by Windows agents to access the workspace in steps. Argument type: String |
agentUncPath | (Optional) UNC path used by Windows CloudBees CD web servers to access the workspace. The agent uses Argument type: String |
agentUnixPath | (Optional) UNIX path used by UNIX agents and Linux CloudBees CD web servers to access the workspace. Argument type: String |
credentialName | (Optional) Credential to use when connecting to a network location. Argument type: String |
description | (Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with Argument type: String |
local | (Optional) < Boolean flag— When the value is Argument type: String |
workspaceDisabled | (Optional) < Boolean flag— When the value is Argument type: String |
zoneName | (Optional) The name of the zone where this workspace resides. Argument type: String |
deleteWorkspace
getWorkspace
modifyWorkspace
Modifies an existing workspace.
A workspace definition consists of three paths to access the workspace in various ways:
agentDrivePath
agentUncPath
—The agent uses agentUncPath
and agentDrivePath
to compute the drive mapping needed to make agentDrivePath
valid in the step (see examples below).
agentUnixPath
Examples for agentDrivePath
and agentUncPath
:
agentDrivePath | agentUncPath | Result from running a step in "job123" that uses this workspace |
---|---|---|
N:\ | `\\server\share ` | The agent maps |
N:\sub1 |
| The agent maps |
N:\sub1 | `\\server\share\dir1 ` | Invalid! No mapping can be deduced from this pair of values. |
C:\ws |
| A local workspace on the agent. No drive mapping is needed. The job step runs in |
C:\ws | Same as if |
You must specify a workspaceName
.
Arguments | Descriptions |
---|---|
workspaceName | The name of the workspace to modify. Argument type: String |
agentDrivePath | (Optional) Drive-letter-based path used by Windows agents to access the workspace in steps. Argument type: String |
agentUncPath | (Optional) UNC path used by Windows CloudBees CD web servers to access the workspace. The agent uses Argument type: String |
agentUnixPath | (Optional) UNIX path used by UNIX agents and Linux CloudBees CD web servers to access the workspace. Argument type: String |
credentialName | (Optional) Argument type: String |
description | (Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with Argument type: String |
local | (Optional) < Boolean flag— If the value is Argument type: Boolean |
newName | (Optional) Enter any name of your choice to rename the workspace. Argument type: String |
workspaceDisabled | (Optional) < Boolean flag— If the value is Argument type: Boolean |
zoneName | (Optional) The name of the zone where this workspace resides. Argument type: String |
resolveFile
Resolves the path to a log file or artifact in a workspace.
You must specify fromAgentId
and workspaceName
.
Arguments | Descriptions |
---|---|
fromAgentId | Identifier of the agent requesting the route to a destination agent or artifact repository. Argument type: Long |
workspaceName | Name of the workspace. Argument type: String |
jobId | (Optional) The unique CloudBees CD -generated identifier (a UUID) for a job that is assigned automatically when the job is created. The system also accepts a job name assigned to the job by its name template. Argument type: UUID |
jobStepId | (Optional) The unique identifier for a job step, assigned automatically when the job is created. Also accepts a job name assigned to the job by its name template. Argument type: UUID |
resourceName | (Optional) Name of the resource. Argument type: String |