This functionality was first introduced in the Hillary release series. The specific methods described on this page work with Hillary R2 and later releases.
...
| Field | Description | Can be empty? | Example or Possible Values |
|---|---|---|---|
| LocationPath | Name of the location. Sub-locations seperated by the pipe symbol "|" | NO | Sample|Node Sample|Node2|Leaf1 Sample|Node2|Leaf2 |
| Target | What category of target is this (Either Application or Device) | NO | Device Application |
| Type | What sub-type of target is this (What type of Device, or Which Application) | NO | See the list of valid target types |
| Name | The name of the location (This is a freeform text field) | NO | Main Lab QA Lab My Test Location |
| Instance Name | The name of the database instance | YES | For scanning database application targets |
| Hostname | The host name for hostname targets | YES | vm-test.localdomain www.myserver.example.com vm-myserver |
| StartIP | The Start IP Address - use this for Application targets, Single, Range and Subnet targets | YES | 10.0.0.1 |
| EndIP | The End IP Address - use this for Range targets only | YES | 10.0.0.99 |
| SubnetMask | The netmask - as a number not as a dotted quad - use for Subnet targets only | YES | Use "24" not "255.255.255.0" "0" can be used for an empty target |
| Port | The port on which to scan, for Application Targets only | YES | E.g. an SQL Server is usually on port 1433 but can be set to an arbitrary number. |
| Exclusion | Whether this is a target exclusion. Use to exclude IP addresses from a larger list | YESNO | Valid values are "True" or "False". Empty implies False |
For a row where the value can be empty, you can either omit the row, or pass in an empty string ("")
The list of valid Device Target types is:
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"Name":"LOCATION TARGET",
"Version":"1.3",
"Locations":
[
{
"LocationPath":"Demo|TestScan",
"Target":"Device",
"Type":"Hostname",
"Name":"Hostname Target 1",
"InstanceName":"",
"Hostname":"vm-myserver",
"StartIP":"",
"EndIP":"",
"SubnetMask":"0",
"Port":"",
"Exclusion":"False"
},
{
"LocationPath":"Demo|TestScan",
"Target":"Device",
"Type":"Single",
"Name":"Single IP Address",
"InstanceName":"",
"Hostname":"",
"StartIP":"10.0.0.1",
"EndIP":"",
"SubnetMask":"0",
"Port":"",
"Exclusion":"False"
},
{
"LocationPath":"Demo|TestScan",
"Target":"Device",
"Type":"Range",
"Name":"Multiple IP Addresses",
"InstanceName":"",
"Hostname":"",
"StartIP":"10.0.0.2",
"EndIP":"10.0.0.99",
"SubnetMask":"0",
"Port":"",
"Exclusion":"False"
},
{
"LocationPath":"Demo|SecondNetwork",
"Target":"Device",
"Type":"Subnet",
"Name":"Different network",
"InstanceName":"",
"Hostname":"",
"StartIP":"192.168.1.0",
"EndIP":"",
"SubnetMask":"24",
"Port":"",
"Exclusion":"False"
}
]
} |
How to invoke the command
...
Note: the encoded username and password pair in the CURL call corresponds to the login 'admin' and password 'password' which are the default iQSonar credentials you are forced to change on when you log in the first time.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --data "@file.json" \
-H 'Authorization: Basic YWRtaW46cGFzc3dvcmQ=' \
-H "Content-Type: application/json" \
-X 'POST' 'http://youriqsonarserver/api/v1/targets' |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
$cred = Get-Credential $body = Get-Content file.json $url = 'http://youriqsonarserver/api/v1/targets' Invoke-RestMethod -Method POST -ContentType 'application/json' -Credential $cred -Body $body -Uri $url |
Worked Example using PowerShell
In the screenshot below, we add two targets (one hostname target and one IP Address target) to the location QALab | MikeTest. The host running iQSonar is on vm-mike-rc
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"Name":"LOCATION TARGET",
"Version":"1.3",
"Locations":
[
{
"LocationPath":"QALab|MikeTest",
"Target":"Device",
"Type":"Hostname",
"Name":"Hostname Target 1",
"InstanceName":"",
"Hostname":"vm-mike-se-w16",
"StartIP":"",
"EndIP":"",
"SubnetMask":"0",
"Port":"",
"Exclusion":"False"
},
{
"LocationPath":"QALab|MikeTest",
"Target":"Device",
"Type":"Single",
"Name":"IP Address Target",
"StartIP":"192.168.0.79",
"Exclusion":"False"
},
{
"LocationPath":"QALab|MikeTest",
"Target":"Device",
"Type":"Single",
"Name":"IP Address Target 2",
"StartIP":"192.168.0.148",
"Exclusion":"False"
}
]
} |
PowerShell screenshot:
Resulting Targets in the Locations screen in iQSonar
Error handling
If there is an error in your JSON data (for example a row that duplicates an existing target, or a syntaxt error) then rather than a result that shows "Completed" with an empty details column, you will get an error message in the Details column. PowerShell truncates this error message (see the screenshot below), but you can view the complete diagnostic error message in the back-end database
Query to return the diagnostic message:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
SELECT TargetConfig, DataOut
FROM [jobs].[t_TargetConfigRequest]
WHERE TargetRequestID=4 |
Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...