{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"Virtual networks are managed by ","type":"text"},{"text":"VMware vSphere","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"Distributed Virtual Switch ","type":"text","marks":[{"type":"strong"}]},{"text":"in order to simplify and scale the network layer. If you already have access to one or many virtual networks in our environment you certainly feel more familiar with this section, if not, you are probably going to use our public networks labeled ","type":"text"},{"text":"VL-1584-VSS-PUBLIC ","type":"text","marks":[{"type":"strong"}]},{"text":"and ","type":"text"},{"text":"VL-0253-EIS-VSS-CGN","type":"text","marks":[{"type":"strong"}]},{"text":", which are DHCP enabled networks and have no firewall enabled due to its nature as just being temporary.","type":"text"}]},{"type":"paragraph","content":[{"text":"We encourage all of our customers to have a custom network segment plumbed into our environment and that can be done first by contacting ","type":"text"},{"text":"U of T Network Administration Tools","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"http://www.its.utoronto.ca/services/129"}}]},{"text":" and then providing the allocated segment and VLAN information to the VSS Team.","type":"text"}]},{"type":"paragraph","content":[{"text":"This resource provides read access to all Virtual Networks permitted in our environment. If by any chance you cannot see a ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"network ","type":"text","marks":[{"type":"strong"}]},{"text":"and you add it to a new Virtual Machine creation request or a NIC change request, your request will not be successfully processed. If you believe you need access to a specific network, please contact us. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]},{"type":"paragraph","content":[{"text":"The following table shows a brief description and HTTP methods allowed to interact with virtual networks.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"5fea9e22-ea8c-4f72-8f2a-a5d870212c26"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[108.0]},"content":[{"type":"paragraph","content":[{"text":"Resource","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"URI","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"GET","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[61.0]},"content":[{"type":"paragraph","content":[{"text":"POST","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"PUT","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[69.0]},"content":[{"type":"paragraph","content":[{"text":"PATCH","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[108.0]},"content":[{"type":"paragraph","content":[{"text":"Network","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"/network","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"List permitted networks and their attributes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[61.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[69.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[108.0]},"content":[{"type":"paragraph","content":[{"text":"Network object","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"/network/","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"Obtain network detail information.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[61.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[69.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[108.0]},"content":[{"type":"paragraph","content":[{"text":"Network VMs","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"/network//vm","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"Virtual machines using a given network","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[61.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[69.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[108.0]},"content":[{"type":"paragraph","content":[{"text":"Network permission","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[234.0]},"content":[{"type":"paragraph","content":[{"text":"/network//permission","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"Network object resource permission list.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[61.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[69.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"paragraph","content":[{"text":"TK ","type":"text","marks":[{"type":"strong"}]},{"text":"stores the Cloud API Token generated as a result of the following POST request to the ","type":"text"},{"text":"/auth/request-token","type":"text","marks":[{"type":"strong"}]},{"text":" resource:","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -X POST https://vss-api.eis.utoronto.ca/auth/request-token -u ","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, extracting the token with the ","type":"text"},{"text":"jq ","type":"text","marks":[{"type":"strong"}]},{"text":"command:","type":"text"}]},{"type":"codeBlock","content":[{"text":"TK=$(curl -X POST https://vss-api.eis.utoronto.ca/auth/request-token -u | jq -r '.token')","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"List","type":"text"}]},{"type":"paragraph","content":[{"text":"In order to list allowed ","type":"text"},{"text":"Networks","type":"text","marks":[{"type":"strong"}]},{"text":" you should make a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"strong"}]},{"text":" request to the endpoint","type":"text"},{"text":" /v2/network","type":"text","marks":[{"type":"strong"}]},{"text":", passing your access token. As a result, you will get a reference URI ","type":"text"},{"text":"/v2/network/","type":"text","marks":[{"type":"strong"}]},{"text":" to get detailed information about that network, human readable name and Managed Object Reference (moref). The following examples uses HTTPie and CURL to list all networks a user have access to:","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"http GET \"https://vss-api.eis.utoronto.ca/v2/network\" \"Authorization: Bearer $TK\"\ncurl -H \"Authorization: Bearer $TK\" -X GET \"https://vss-api.eis.utoronto.ca/v2/network\"","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response Body","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"{\n \"_links\": {\n \"self\": \"https://vss-api.eis.utoronto.ca/v2/network?short=1\"\n },\n \"data\": [\n {\n \"label\": \"Quarantine N/A Quarantine no access DVPG\",\n \"moref\": \"dvportgroup-11137\",\n \"name\": \"Quarantine\",\n \"vim_type\": \"vim.dvs.DistributedVirtualPortgroup\",\n \"vlan_id\": \"0\"\n },\n {\n \"label\": \"VL-1584-VSS-PUBLIC 142.1.216.0/23 VSS Public network\",\n \"moref\": \"dvportgroup-11052\",\n \"name\": \"VL-1584-VSS-PUBLIC\",\n \"vim_type\": \"vim.dvs.DistributedVirtualPortgroup\",\n \"vlan_id\": \"1584\"\n }\n ],\n \"meta\": {\n \"count\": 6,\n \"pages\": {\n \"first_url\": \"https://vss-api.eis.utoronto.ca/v2/network?per_page=100&page=1&expand=1\",\n \"last_url\": \"https://vss-api.eis.utoronto.ca/v2/network?per_page=100&page=1&expand=1\",\n \"next_url\": null,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 100,\n \"prev_url\": null,\n \"total\": 6\n },\n \"time\": \"0.00960s\",\n \"user\": \"jm\"\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Paging","type":"text"}]},{"type":"paragraph","content":[{"text":"All requests to the ","type":"text"},{"text":"/network ","type":"text","marks":[{"type":"strong"}]},{"text":"URL are paginated. The response body includes a '","type":"text"},{"text":"meta.pages","type":"text","marks":[{"type":"strong"}]},{"text":"' key with everything to navigate through the results, for instance:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"e6b6a603-fb46-4a6f-ae7c-ad3f28e4308d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"Key","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"first_url","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":4,"colwidth":[618.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Contain the URLs to navigate through results.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"last_url","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"prev_url","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"next_url","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"page","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Current page","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"pages","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Total number of pages","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"per_page","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Results per page. Maximum 250; Default 10.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[141.0]},"content":[{"type":"paragraph","content":[{"text":"total","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Total number of results","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Results per page can be set by including the parameter in the URL query, so we can get the desired number of elements per page, for example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"http GET \"https://vss-api.eis.utoronto.ca/v2/network?per_page=1\" \"Authorization: Bearer $TK\"\ncurl -H \"Authorization: Bearer $TK\" -X GET \"https://vss-api.eis.utoronto.ca/v2/network?per_page=1\"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Filtering","type":"text"}]},{"type":"paragraph","content":[{"text":"Networks can be filtered by adding the ","type":"text"},{"text":"filter ","type":"text","marks":[{"type":"strong"}]},{"text":"argument to the query string in the following format:","type":"text"}]},{"type":"codeBlock","content":[{"text":"filter=,,","type":"text"}]},{"type":"paragraph","content":[{"text":"Operators can be:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"296943be-4a67-4cab-8efd-d78f2499a7ee"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Operator","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"eq","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Equals","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"ne","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Not equal","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"lt","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Lower than","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"le","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Lower equal","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"gt","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Greater than","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"ge","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Greater equal","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"like","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Matching pattern","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"in","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"Match value in many items separated by commas","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"A resource can be filtered by as many attributes the request has, for instance ","type":"text"},{"text":"/networks ","type":"text","marks":[{"type":"strong"}]},{"text":"can be filtered by","type":"text"},{"text":" description, created_on, vms, vlan_id, subnet, name, admin, moref, label, updated_on, ports, etc.","type":"text","marks":[{"type":"strong"}]},{"text":" Thus, the following example will filter only by name=PUBLIC","type":"text"}]},{"type":"codeBlock","content":[{"text":"http GET \"https://vss-api.eis.utoronto.ca/v2/network?per_page=10&expand=1&filter=name,like,%PUBLIC%\" \"Authorization: Bearer $TK\"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sorting","type":"text"}]},{"type":"paragraph","content":[{"text":"The resource provides also attribute sorting by adding the ","type":"text"},{"text":"sort ","type":"text","marks":[{"type":"strong"}]},{"text":"parameter in the URL query string in the following format:","type":"text"}]},{"type":"codeBlock","content":[{"text":"sort=,","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows how to filter by ","type":"text"},{"text":"label","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"http GET \"https://vss-api.eis.utoronto.ca/v2/network?per_page=10&expand=1&filter=name,like,%VL%&sort=label,desc\" \"Authorization: Bearer $TK\"\n\ncurl -X GET -H \"Authorization: Bearer $TK\" \"https://vss-api.eis.utoronto.ca/v2/network?per_page=10&expand=1&filter=name,like,%VL%&sort=label,desc\" ","type":"text"}]},{"type":"paragraph","content":[{"text":"List specific Network Info","type":"text"}]},{"type":"paragraph","content":[{"text":"Some of the attributes will have an object value. Such is the case of items in attribute ","type":"text"},{"text":"vms","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"857b52ef-4148-433a-b253-21a4f66fddee"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"admin","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Network owner/administrator","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"description","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Virtual Network description.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Virtual Network name.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"ports","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Number of ports in the port group. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"moref","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Network identifier","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"subnet","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Network subnet with mask","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"vlan_id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"VLAN id or range","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[143.0]},"content":[{"type":"paragraph","content":[{"text":"vms","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[94.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[522.0]},"content":[{"type":"paragraph","content":[{"text":"Number of virtual machines on the network.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The following example, requests information about a particular Network using the base resource ","type":"text"},{"text":"/v2/network","type":"text","marks":[{"type":"strong"}]},{"text":" and appending the ","type":"text"},{"text":"moref","type":"text","marks":[{"type":"strong"}]},{"text":" to get the URI ","type":"text"},{"text":"/v2/network/dvportgroup-92:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"http GET https://vss-api.eis.utoronto.ca/v2/network/dvportgroup-11052 \"Authorization: Bearer $TK\"\ncurl -H \"Authorization: Bearer $TK\" -X GET https://vss-api.eis.utoronto.ca/v2/network/dvportgroup-11052","type":"text"}]},{"type":"paragraph","content":[{"text":"HTTP response body would look something like:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response Body","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"{\n \"_links\": {\n \"network\": \"https://vss-api.eis.utoronto.ca/v2/network\",\n \"self\": \"https://vss-api.eis.utoronto.ca/v2/network/dvportgroup-11052\"\n },\n \"data\": {\n \"admin\": \"Jose Manuel Lopez Lujan:123-456-7890:dns-adm@eis.utoronto.ca\",\n \"created_on\": \"2019-07-09 Tue 21:15:56 EDT\",\n \"description\": \"VSS Public network\",\n \"label\": \"VL-1584-VSS-PUBLIC 142.1.216.0/23 VSS Public network\",\n \"moref\": \"dvportgroup-11052\",\n \"name\": \"VL-1584-VSS-PUBLIC\",\n \"ports\": 67,\n \"subnet\": \"142.1.216.0/23\",\n \"updated_on\": \"2019-07-11 Thu 09:02:08 EDT\",\n \"vim_type\": \"vim.dvs.DistributedVirtualPortgroup\",\n \"vlan_id\": \"1584\",\n \"vms\": 59\n },\n \"meta\": {\n \"count\": 12,\n \"time\": \"0.00866s\",\n \"user\": \"jm\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported