Submit deployment procedure
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedures/{deploymentProcedureId}/actions/submit
Submit Deployment Procedures provided in request body. In emcli, it is equivalent to 'submit_procedure'
Request
Path Parameters
-
deploymentProcedureId(required): string
Id of a Procedure.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Inputs for Deployment Procedure submission
Show Source
-
automaticRerunDelayInMinutes: number
Positive values set the delay between automatic rerun attempts,of the DP steps, the units of such delay are minutes.Example:
10
-
instanceName: string
Deployment Procedure Instance NameExample:
hostcommand-testsubmit
-
maxAutomaticRerunsCount: number
It determine the automatic rerun behaviour of the DP steps. Only failed or aborted DP steps are resubmitted or retried; successful DP steps are never rerun, regardless of these options' valuesExample:
5
-
notification: object
Notification
Status of the deployment procedure instance for which the end-users can choose to be notified.
-
schedule: object
Schedule
Schedule details
-
targetLists: array
DeploymentProcedureTargetList
Defining list of procedure targets
-
variables: object
DeploymentProcedureVariableCollection
Collections of Procedure Variable
Nested Schema : Notification
Type:
object
Status of the deployment procedure instance for which the end-users can choose to be notified.
Show Source
-
value: string
The status of the procedure.All available status are scheduled, running, action required, succeeded, problems, suspended
Nested Schema : Schedule
Type:
object
Schedule details
Show Source
-
isTargetZone: boolean
To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition
-
recurring: string
Frequency at which the operation must be executed repeatedlyExample:
frequency:weekly;days:2,
-
scheduleType: string
Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON.
-
startGracePeriodInMinutes: integer
Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.Example:
60
-
timeToEnd: string
(date-time)
End time
-
timeToStart: string
(date-time)
Start time
Nested Schema : DeploymentProcedureTargetList
Type:
array
Defining list of procedure targets
Show Source
Nested Schema : DeploymentProcedureVariableCollection
Type:
object
Collections of Procedure Variable
Show Source
-
items: array
items
The list of procedure variables
Nested Schema : items
Type:
Show Source
object
-
name: string
name of target typeExample:
host
-
targets: object
DeploymentProcedureTargetCollection
Collections of Procedure Target
Nested Schema : DeploymentProcedureTargetCollection
Type:
object
Collections of Procedure Target
Show Source
-
items: array
items
The list of targets
Nested Schema : items
Type:
array
The list of targets
Show Source
-
Array of:
object DeploymentProcedureTargetSummary
This is the representation of Procedure Target
Nested Schema : DeploymentProcedureTargetSummary
Type:
object
This is the representation of Procedure Target
Match All
Show Source
-
object
DeploymentProcedureTargetDetails
Defining Target for Deployment Procedure
Nested Schema : DeploymentProcedureTargetDetails
Type:
object
Defining Target for Deployment Procedure
Show Source
-
credentialReferences: array
CredentialReference
This is the representation of credential references.
-
targetName: string
Target NameExample:
host1.oracle.com
-
targetType: string
Target TypeExample:
host
Nested Schema : CredentialReference
Type:
array
This is the representation of credential references.
Show Source
Nested Schema : items
Type:
Show Source
object
-
credentialName: string
Represents credential nameExample:
EMGA
-
credentialType: string
Represents type of the credentialExample:
NAMED
-
owner: string
Represents owner of the credentialExample:
SYSMAN
-
usage: string
Represents credential usageExample:
defaultHostCred
Nested Schema : items
Type:
array
The list of procedure variables
Show Source
-
Array of:
object DeploymentProcedureVariableSummary
This is the representation of Procedure Variable
Nested Schema : DeploymentProcedureVariableSummary
Type:
object
This is the representation of Procedure Variable
Match All
Show Source
-
object
DeploymentProcedureVariableDetails
Defining Variable for Deployment Procedure
Nested Schema : DeploymentProcedureVariableDetails
Type:
object
Defining Variable for Deployment Procedure
Show Source
-
variableName: string
Displays Deployment Procedure varibale nameExample:
userId
-
variableValue: string
Displays Deployment Procedure varibale valueExample:
10001
Response
Supported Media Types
- application/json
202 Response
A request to submit the deployment procedure was accepted
Headers
-
Location:
URL to get the status of submit Procedure action.
Root Schema : schema
Type:
Show Source
object
-
code: string
codeExample:
202
-
message: string
Rest Api message for submit procedure.Example:
A request to submit the deployment procedure was accepted
400 Response
Bad Request. The payload is null or missing some parameters
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden. The user is forbidden to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
404 Response
Not Found. The requested REST API URL is not found.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string