[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Validate Environment V2

Description

This API is used to validate a create environment payload. This needs to be triggered before creating an environment.

Request

Request

URL

URL


post
https://localhost:8080/lcm/lcops/api/v2/environments/pre-validate
Copy

Request Body

Request Body

EnvironmentRequestDTO of type(s) application/json Required

environmentRequestDTO

{
	"environmentDescription": "vRealize Automation Environment",
	"environmentHealth": "string",
	"environmentId": "string",
	"environmentName": "vRealize Automation Environment",
	"environmentStatus": "COMPLETED",
	"infrastructure": {
		"properties": {
			"key": "<ntp-server1>,<ntp-server2> | false | true | <storage> | <folder> | <domain> | vcenter-1.example.com | adminuser@vmware.com | locker:certificate:<vmid>:<alias> | <vc-datacenter>#<cluster> | <dns-server1-ip>,<dns-server2-ip> | <gateway> | <subnet mask> | <search path> | default | default | vCenter-1 | administrator@vsphere.local | locker:password:<vmid>:<alias> | true | locker:password:<vmid>:<alias> | <resource-pool> | d250f635-df41-44b9-b44c-1705c1ed304f | <network> | <host/ntp> | thin"
		}
	},
	"logHistory": "string",
	"metaData": {
		"key": "string"
	},
	"products": [
		{
			"clusterVIP": {
				"clusterVips": [
					{
						"properties": {
							"key": "string"
						},
						"type": "string"
					}
				]
			},
			"collectorGroups": {
				"collectorGroups": [
					{
						"description": "string",
						"id": "d7d5624a-f975-48c0-864b-868ca883d979",
						"name": "test collector group",
						"nodes": [
							{
								"properties": {
									"key": "string"
								},
								"type": "vrava-primary"
							}
						]
					}
				],
				"collectorsName": [
					"string"
				],
				"operationType": "add"
			},
			"id": "vra",
			"logHistory": "string",
			"nodes": [
				{
					"properties": {
						"key": "string"
					},
					"type": "vrava-primary"
				}
			],
			"patchHistory": "string",
			"properties": {
				"key": "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


infrastructure Optional

string
logHistory Optional

Log History Data


map of string
metaData Optional

array of Product
products Optional
Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

201 Created returns GenericRequestResponse of type(s) application/json
{
	"requestId": "a0d8d8cd-ac87-4b5c-ba8b-7a0173c56b55"
}
string
requestId Optional

Request ID

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"environmentDescription":"vRealize Automation Environment","environmentHealth":"string","environmentId":"string","environmentName":"vRealize Automation Environment","environmentStatus":"COMPLETED","infrastructure":{"properties":{"key":"<dns-server1-ip>,<dns-server2-ip> | <subnet mask> | vCenter-1 | true | adminuser@vmware.com | <storage> | thin | <network> | <search path> | default | vcenter-1.example.com | locker:certificate:<vmid>:<alias> | false | <domain> | administrator@vsphere.local | <vc-datacenter>#<cluster> | <folder> | <resource-pool> | <gateway> | <host/ntp> | d250f635-df41-44b9-b44c-1705c1ed304f | default | locker:password:<vmid>:<alias> | true | locker:password:<vmid>:<alias> | <ntp-server1>,<ntp-server2>"}},"logHistory":"string","metaData":{"key":"string"},"products":[{"clusterVIP":{"clusterVips":[{"properties":{"key":"string"},"type":"string"}]},"collectorGroups":{"collectorGroups":[{"description":"string","id":"d7d5624a-f975-48c0-864b-868ca883d979","name":"test collector group","nodes":[{"properties":{"key":"string"},"type":"vrava-primary"}]}],"collectorsName":["string"],"operationType":"add"},"id":"vra","logHistory":"string","nodes":[{"properties":{"key":"string"},"type":"vrava-primary"}],"patchHistory":"string","properties":{"key":"string"},"snapshotHistory":"string","version":"8.3.0"}]}' https://localhost:8080/lcm/lcops/api/v2/environments/pre-validate


Feedback

Was this page helpful?