Adds a new advanced query.
Add-DRAAdvancedQuery -Properties <Hashtable> [-DRAHostServer <String>] [-DRAHostPort <Int32>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Add-DRAAdvancedQuery cmdlet creates a new advanced query in DRA with the properties specified. You must have the Create Private Advanced Query power to create queries in the 'My' query folder and the Create Public Advanced Query power to create queries in the 'Public' query folder. The following properties must be set:BaseContainer, Query, IncludeChildContainers, Columns and either QueryIdentifier or both Name and QueryFolder.
Attribute / Description |
Parameters / Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
Properties <Hashtable> A hashtable of property values. The key is the name of a defined property in the REST interface. For example: -Properties @{Description="Finds all computers"} Multiple values are specified as a comma-separated list.For example: -Properties @{Columns="class","path","friendlyName"} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Properties @{Description="my `"test`" query"} |
true |
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-DRAAdvancedQuery -detailed". For technical information, type "Get-Help Add-DRAAdvancedQuery -full".
Example 2-1 1
PS C:\>Add-DRAAdvancedQuery @{BaseContainer="OnePoint://DC=MyDomain,DC=corp"; Name="All Computers";Columns="path","friendlyName","class";QueryFolder="My";Query="(objectClass=computer)";IncludeChildContainers=$true}
Creates a new private advanced query that returns the path and friendlyName of all computer objects in the MyDomain.corp domain.