Export Product V2 Using GET
This API is used to export product configuration.
Request
URI
GET
https://{api_host}/lcm/lcops/api/v2/environments/{environmentId}/products/{productId}/configuration
COPY
Path Parameters
string
environmentId
Required
environmentId
string
productId
Required
productId
Query Parameters
string
tenantId
Optional
tenantId
string
type
Required
simple/advanced
Responses
200
OK
Returns EnvironmentRequestDTO of type(s) application/json
{
"environmentDescription": "vRealize Automation Environment",
"environmentHealth": "string",
"environmentId": "string",
"environmentName": "vRealize Automation Environment",
"environmentStatus": "COMPLETED",
"infrastructure": {
"properties": {
"dataCenterVmid": "d250f635-df41-44b9-b44c-1705c1ed304f",
"regionName": "default",
"zoneName": "default",
"vCenterName": "vCenter-1",
"vCenterHost": "vcenter-1.example.com",
"vcUsername": "[email protected]",
"vcPassword": "locker:password:<vmid>:<alias>",
"acceptEULA": "true",
"enableTelemetry": "true",
"adminEmail": "[email protected]",
"defaultPassword": "locker:password:<vmid>:<alias>",
"certificate": "locker:certificate:<vmid>:<alias>",
"cluster": "<vc-datacenter>#<cluster>",
"storage": "<storage>",
"folderName": "<folder>",
"resourcePool": "<resource-pool>",
"diskMode": "thin",
"network": "<network>",
"masterVidmEnabled": "false",
"dns": "<dns-server1-ip>,<dns-server2-ip>",
"domain": "<domain>",
"gateway": "<gateway>",
"netmask": "<subnet mask>",
"searchpath": "<search path>",
"timeSyncMode": "<host/ntp>",
"ntp": "<ntp-server1>,<ntp-server2>"
}
},
"logHistory": "string",
"metaData": {
"metaData": "string"
},
"products": [
{
"clusterVIP": {
"clusterVips": [
{
"properties": {
"properties": "string"
},
"type": "string"
}
]
},
"collectorGroups": {
"collectorGroups": [
{
"description": "string",
"id": "d7d5624a-f975-48c0-864b-868ca883d979",
"name": "test collector group",
"nodes": [
{
"properties": {
"properties": "string"
},
"type": "vrava-primary"
}
]
}
],
"collectorsName": [
"string"
],
"operationType": "add"
},
"id": "vra",
"logHistory": "string",
"nodes": [
{
"properties": {
"properties": "string"
},
"type": "vrava-primary"
}
],
"patchHistory": "string",
"properties": {
"properties": "string"
},
"snapshotHistory": "string",
"version": "8.3.0"
}
]
}
string
environmentDescription
Optional
Environment Description
string
environmentHealth
Optional
Environment Health Data
string
environmentId
Optional
Environment ID
string
environmentName
Optional
Environment Name
string
environmentStatus
Optional
Status of the environment
string
logHistory
Optional
Log History Data
object
metaData
Optional
metaData
400
Bad Request
Returns GenericErrorResponseDTO of type(s) application/json
{
"errorCode": "LCM_EXAMPLE_API_ERROR0000",
"errorLabel": "Example Error!",
"message": "Something went wrong!",
"recommendations": []
}
string
errorCode
Optional
errorCode
string
errorLabel
Optional
errorLabel
string
message
Optional
message
array of string
recommendations
Optional
recommendations
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Not Found
Returns GenericErrorResponseDTO of type(s) application/json
{
"errorCode": "LCM_EXAMPLE_API_ERROR0000",
"errorLabel": "Example Error!",
"message": "Something went wrong!",
"recommendations": []
}
string
errorCode
Optional
errorCode
string
errorLabel
Optional
errorLabel
string
message
Optional
message
array of string
recommendations
Optional
recommendations
500
Internal Server Error
Returns GenericErrorResponseDTO of type(s) application/json
{
"errorCode": "LCM_EXAMPLE_API_ERROR0000",
"errorLabel": "Example Error!",
"message": "Something went wrong!",
"recommendations": []
}
string
errorCode
Optional
errorCode
string
errorLabel
Optional
errorLabel
string
message
Optional
message
array of string
recommendations
Optional
recommendations
On This Page
Deployments Controller Operations
POST
Apply Product Patch V2 Using POST
POST
Check Product Health V2 Using POST
POST
Create Product Snapshot Request V2 Using POST
Deprecated
PUT
Create Product Update Certificate Request V2 Using PUT
POST
Create Product Upgrade Request V2 Using POST
DELETE
Delete Product Data Source Request V2 Using DELETE
DELETE
Delete Product Logs Using DELETE
DELETE
Delete Product V2 Using DELETE
GET
Download Product Logs V2 Using GET
GET
Export Product V2 Using GET
POST
Generate Product Logs V2 Using POST
GET
Get All Product Snapshots V2 Using GET
Deprecated
GET
Get Compatablity Matrix V2 Using GET
GET
Get Deployed Product Vms V2 Using GET
GET
Get Product Certificate V2 Using GET
GET
Get Product Details V2 Using GET
GET
Get Product Patch Details V2 Using GET
GET
Get Product Snapshot By Snapshot Name V2 Using GET
Deprecated
POST
Power On Product V2 Using POST
POST
Revert Product Snapshot Request V2 Using POST
Deprecated
POST
Shut Down Product V2 Using POST
POST
Trigger Inventory Sync For Product V2 Using POST
PUT
Update Node Password Request V2 Using PUT
PUT
Update Product Admin Password Request V2 Using PUT
PUT
Update Product Data Source Password Request V2 Using PUT
POST
Validate Patch Product V2 Using POST
POST
Validate Product Data Source Password Request V2 Using POST
POST
Validate Product Update Certificate Request V2 Using POST
POST
Validate Vertical Scale Up Request V2 Using POST
POST
Vertical Scale Up Request V2 Using POST