Creates a generic Workflow Process event.
Add-DRAWorkflowEvent -EventName <String> [-WorkflowParameters <Hashtable>] [-DRAHostServer <String>] [-DRAHostPort <Int32>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Add-DRAWorkflowEvent cmdlet creates a new generic Workflow Process event. Additional information can be included in the event's iqcmiXMLData attribute using the -WorkflowParameters parameter. The format of WorkflowParameters is a Hashtable of name/value pairs. All values will be converted to strings before being sent to DRA.
Attribute / Description |
Parameters / Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
EventName <String> The name of the workflow event to create. |
true |
named |
true (ByPropertyName) |
false |
|
WorkflowParameters [<Hashtable>] An optional hashtable of name/value pairs that will be included in the workflow event. |
false |
named |
true (ByPropertyName) |
false |
|
DRAHostServer [<String>] The name of the computer running the DRA Host Service. The DRA REST server will send the requested operation to the DRA Host Service running on the specified computer. If this parameter is not specified, then the DRA REST Service will attempt to discover a DRA Host Service to use. |
false |
named |
|
true (ByPropertyName) |
false |
DRAHostPort [<Int32>] The port number of the DRA Host Service. This parameter is only used when the DRAHostServer parameter is also specified. If the DRAHostServer parameter is specified but the DRAHostPort is not, 11192 will be used as the default Host port. |
false |
named |
11192 |
true (ByPropertyName) |
false |
DRARestServer [<String>] The name of the computer running the DRA REST Service. The requested DRA operation will be sent to the REST Service running on the specified computer. If this parameter is not specified, then the cmdlet will attempt to discover a DRA REST Service to use. |
false |
named |
|
true (ByPropertyName) |
false |
DRARESTPort [<Int32>] The port number of the DRA REST Service. This parameter is only used when the DRARestServer parameter is also specified. If the DRARestServer parameter is specified but the DRARestPort is not, 8755 will be used as the default REST port. |
false |
named |
8755 |
true (ByPropertyName) |
false |
IgnoreCertificateErrors [<SwitchParameter>] Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate. |
false |
named |
false |
false |
|
Force [<SwitchParameter>] Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user. |
false |
named |
|
false |
false |
Timeout [<Int32>] The number of seconds to wait before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1. |
false |
named |
100 seconds |
true (ByPropertyName) |
false |
<CommonParameters> Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters. |
|
|
|
|
|
NOTE:For more information, type "Get-Help Add-DRAWorkflowEvent -detailed". For technical information, type "Get-Help Add-DRAWorkflowEvent -full".
Example 28-1 1
PS C:\>Add-DRAWorkflowEvent -EventName "DraAddToGroupRequest" -WorkflowParamters @{ UserName = "myDomain\demouser"; GroupDn = "CN=Sales,CN=Users,DC=myDomain,DC=corp"}
This example creates a Workflow Process event named DraAddToGroupRequest. The event will also contain a formatted XML representation of the UserName and GroupDn specified in the WorkflowParameters. For example:
<?xml version="1.0" encoding="utf-16"?><parameter-list><UserName>myDomain\demouser</UserName><GroupDn>CN=Sales,CN=Users,DC=myDomain,DC=corp</GroupDn></parameter-list>
The XML is stored in the event's iqcimXMLData attribute.