Get all monitors over a firewall

Description

Retrieves a list of all existing monitors over a firewall.

URL

Copy code
/LoadTest/rest/domains/{domainName}/projects/{projectName}/mofw

HTTP method

GET: Returns the monitors over a firewall in the body of the response.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

Version Cookie
2020 or later

LWSSO_COOKIE_KEY={LwssoCookie};

Earlier than 2020

LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

Request body:

None

Request example:

Copy code
GET http://<LRE_Server>/LoadTest/rest/domains/MyDomain/projects/MyProject/mofw

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML return code:

One of the HTTP return codes

HTML body:

The XML or JSON containing the monitors over a firewall.

Response examples:

Copy code
XML example:
<MonitorsOfw xmlns="http://www.hp.com/PC/REST/API">
  <MonitorOfw>
     <Name>mon_ofw_1</Name>
     <MIListenerID>1002</MIListenerID> 
     <MachineKey>>pclab.net_ofw</MachineKey>
     <FolderID>1002</FolderID>
     <Description />
     <ID>1020</ID>
     <FolderName>MONS_OFW</FolderName>
  </MonitorOfw>
  <MonitorOfw>
     <Name>mon_ofw_2</Name>
     <MIListenerID>1003</MIListenerID> 
     <MachineKey>my-vm01_ofw</MachineKey>
     <FolderID>1002</FolderID><Description />
     <ID>1021</ID>
     <FolderName>MONS_OFW</FolderName>
  </MonitorOfw>
  <MonitorOfw>
     <Name>mon_ofw_3</Name>
     <MIListenerID>1003</MIListenerID> 
     <MachineKey>my-vm02_ofw</MachineKey>    
     <FolderID>1002</FolderID>
     <Description />
     <ID>1022</ID>
     <FolderName>MONS_OFW</FolderName>
  </MonitorOfw>
  <MonitorOfw>
     <Name>mon_ofw_4</Name>
     <MIListenerID>1007</MIListenerID> 
     <MachineKey>my-vm07_ofw</MachineKey>
     <FolderID>1111</FolderID>
     <Description />
     <ID>1022</ID>
     <FolderName>MONS_OFW</FolderName>
  </MonitorOfw>
</MonitorsOfw>
Copy code
JSON example:
[    
{       
        "ID": 1040,
        "FolderName": null,
        "Name": "radu-monitor-ofw",
        "MIListenerID": 1092,
        "MachineKey": "mofw_ofw",
        "FolderID": 1020,
        "Description": null    
}
]
Copy code
XML example query that retrieves monitor names with folder IDs greater that 1002:
GET http://my-vm2468/LoadTest/rest/domains/MyDomain/projects/MyProject/mofw?fields=Name&query={ FolderID[>1002]}

MonitorsOfw xmlns="http://www.hp.com/PC/REST/API"> 
   <MonitorOfw>
       <Name>mon_ofw_1</Name>
   </MonitorOfw> <MonitorOfw>
       <Name>mon_ofw_2</Name>
   </MonitorOfw>
   <MonitorOfw>
       <Name>mon_ofw_3</Name>
   </MonitorOfw>
   <MonitorOfw>
       <Name>mon_ofw_4</Name>
   </MonitorOfw>
</MonitorsOfw>

See also: