Get Networks

Table 1. API: GET SCVMM Networks
Element Description
API GetScvmmNetworkMaster
Description API Returns SCVMM network(s) exists in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/scvmm/provisioningEndPoints/{endpointId}/networks
URL Parameters (fields in curly {} braces)
  • endpointId (Mandatory): This is a unique identifier of Cloud Endpoint created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name of the Platform available on Manage Provisioning Platform screen.
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
  • Filter: To filter records based on column name received from output. E.g. Filter="keyname='keyvalue'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
  • For e.g. 
    {"filter": "totalAllocatedIp=’1’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}
Header
  • Authorization Key : The initial step that needs to be performed before consuming HCL BigFix CLM API is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response

A Sample Response:

{
"totalRecords": 1,
 "records": [
 {
 "entityId": "NTW-404CD49F-10E5-4052-833A-4A76E207AF82",
 "actualIdOnEnvironment": "2f1f817a-b902-4f78-8563-01f4fa5b3119",
 "name": "Cisco VIC Ethernet Interface #2 - Virtual Switch",
 "totalAllocatedIp": 1,
 "totalFreeIp": 0,
 "platformEntityId": "SCVM2-8F1E78E7-04D3-4AAF-822F-4D9D1E63DACD",
 "cloudName": "Test",
 "cloudActualIdOnEnvironment": "b6430c9d-90f4-4400-b5c2-afe465800d85",
 "hostName": "xxxxxx",
 "hostActualIdOnEnvironment": "beee7980-10e6-4374-9ef4-30e53d978597",
 "associatedServicePlans": [
 {
 "servicePlanId": "2",
 "servicePlanName": "silver"
 }
 ]
 }
 ]
}
Response Parameters
  • Result:
  • entityId
  • actualIdOnEnvironment
  • name
  • totalAllocatedIp
  • totalFreeIp
  • platformEntityId
  • cloudName
  • cloudActualIdOnEnvironment
  • hostName
  • hostActualIdOnEnvironment
  • associatedServicePlans