ConsumerClient
getAllResources
Return all resources that are available to the current user.
Parameters
- [string]show = This determines what is returned. Use json to return a json object or table to return a table. This parameter is not mandatory.
- [int]limit = This determines how many entries are returned. If not specified, it will default to 20.
By default this function will return a table containing the id and name of the resource.
client.getAllResources()
This can be changed by adding the show parameter as follows:
resources = client.getAllResources(show='json')
show='json' will return an object. You can interact with this object in the same way that you would with any object.
resources = client.getAllResources(show='json')
for resource in resources:
print resource['id']
print resource['name']
If you want to return a json string, you will need to use json.dumps().
resources = client.getAllResources(show='json')
resourcesJSONString = json.dumps(resources)
print resourcesJSONString
getResource
Get a vRA resource by Id
Parameters
- [string]id = id of the vRA resource
- [string]show = This determines what is returned. Use json to return a json object or table to return a table. This parameter is not mandatory.
You can display data from this function in a table as follows:
resourceId='171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
client.getResource(id=resourceId, show='table')
By default this function will return a json object. You can interact with this object in the same way that you would with any object.
resourceId='171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
resource = client.getResource(id=resourceId)
print resource['id']
print resource['name']
If you want to return a json string, you will need to use json.dumps().
resourceId='171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
resource = client.getResource(id=resourceId)
resourceJSONString = json.dumps(resource)
print resourcesJSONString
getResourceByName
Get a vRA resource by name
Parameters
- [string]name = name of the vRA resource
- [string]show = This determines what is returned. Use json to return a json object or table to return a table. This parameter is not mandatory.
You can display data from this function in a table as follows:
resourceName='vra-test-01'
client.getResourceByName(name=resourceName, show='table')
By default this function will return a json object. You can interact with this object in the same way that you would with any object.
resourceName='vra-test-01'
resource = client.getResourceByName(name=resourceName)
print resource['id']
print resource['name']
If you want to return a json string, you will need to use json.dumps().
resourceName='vra-test-01'
resource = client.getResourceByName(name=resourceName)
resourceJSONString = json.dumps(resource)
print resourcesJSONString
getResourceNetworking
Return networking information for a given resource.
Parameters
- [string]id = Id of the vRA Resource
- [string]show = This determines what is returned. Use json to return a json object or table to return a table. This parameter is not mandatory.
You can display data from this function in a table as follows:
resourceId='171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
client.getResourceNetworking(id=resourceId, show='table')
By default this function will return a json object. You can interact with this object in the same way that you would with any object.
resourceId='171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
resourceNetworking = client.getResourceNetworking(id=resourceId)
for i in networking:
print i['key']
print i['value']['value']
If you want to return a json string, you will need to use json.dumps().
resourceId = '171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
resourceNetworking = client.getResourceNetworking(id=resourceId)
resourceNetworkingJSONString = json.dumps(networking)
print resourceNetworkingJSONString
getEntitledCatalogItems
Return all entitled catalog items for the current user.
Parameters
- [string]show = This determines what is returned. Use json to return a json object or table to return a table. This parameter is not mandatory.
- [int]limit = This determines how many entries are returned. If not specified, it will default to 20.
By default this function will return a table containing the id and name of the resource.
client.getEntitledCatalogItems()
This can be changed by adding the show parameter as follows:
entitledCatalogItems = client.getEntitledCatalogItems(show='json')
show='json' will return an object. You can interact with this object in the same way that you would with any object.
entitledCatalogItems = client.getEntitledCatalogItems(show='json')
for i in entitledCatalogItems:
print i['catalogItem']['id']
print i['catalogItem']['name']
If you want to return a json string, you will need to use json.dumps().
entitledCatalogItems = client.getEntitledCatalogItems(show='json')
entitledCatalogItemsJSONString = json.dumps(entitledCatalogItems)
print entitledCatalogItemsJSONString
getRequest
Return information on a given request
Parameters
- [string]id = id of the vRA request
- [string]show = This determines what is returned. Use json to return a json object or table to return a table. This parameter is not mandatory.
By default this function will return a table.
requestId = '171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
client.getRequest(id=requestId)
This can be changed by adding the show parameter as follows:
requestId = '171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
request = client.getRequest(id=requestId, show='json')
show='json' will return an object. You can interact with this object in the same way that you would with any object.
requestId = '171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
request = client.getRequest(id=requestId, show='json')
print request['id']
print request['name']
If you want to return a json string, you will need to use json.dumps().
requestId = '171d8ab9-1b5b-44e8-ac20-b559da4c1ef3'
request = client.getRequest(id=requestId, show='json')
requestJSONString = json.dumps(request)
print requestJSONString
getAllRequests
Get All requests
Parameters
- [string]show = This determines what is returned. Use json to return a json object or table to return a table. This parameter is not mandatory.
- [int]limit = This determines how many entries are returned. If not specified, it will default to 20.
By default this function will return a table containing the id, requestNumber, requestedItemName and state of each request.
client.getAllRequests()
This can be changed by adding the show parameter as follows:
requests = client.getAllRequests(show='json')
show='json' will return an object. You can interact with this object in the same way that you would with any object.
requests = client.getAllRequests(show='json')
for request in requests:
print resource['id']
print resource['requestedItemName']
If you want to return a json string, you will need to use json.dumps().
requests = client.getAllRequests(show='json')
requestsJSONString = json.dumps(requests)
print requestsJSONString
getRequestResource
Retrieves the resources that were provisioned as a result of a given request
Parameters
- [string]id = Request id of the vRA resource
When you deploy a machine with requestResource() it will return the request id. Use this function to get the ID of the resource you have just deployed. Once you have the resource id, you can go on to query things like networking.
Example with getResourceNetworking
resource = client.getRequestResouce(requestId)
resourceId = resource['id']
resourceNetworking = client.getResourceNetworking(resourceId)
for i in resourceNetworking:
print "{key} : {value}".format(key=i['key'], value=i['value']['value'])
requestResource
Submit a request based on payload
This function will return the id of the request.
Parameters
- [json]payload = json request (example: request.json)
Before using this function you will need to generate a blueprint request file.
To do this follow the instructions on Grant Orchards blog here
Basic example:
#!/usr/bin/python
import getpass
import json
import os
from globalconfig import passwd, url, usr
from vraapiclient import catalog
#Get the current directory
currentDirectory = os.path.dirname(os.path.abspath(__file__))
client = catalog.ConsumerClient(url, usr, passwd)
#Create the JSON payload for the Post
with open('requestFormatted.json') as f:
payload = json.load(f)
request = client.requestResource(payload)
print "Request submitted: {id}".format(id=request)
For more detailed examples please see the examples/requests directory of this project