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

Toggle VCF Environment

Description

Toggle VCF Environment

Request

Request

URL

URL


post
https://localhost:8080/lcm/lcops/api/v2/environments/{environmentId}/toggleVcfEnvironment
Copy

Path Parameters

Path Parameters

string
environmentId Required

environmentId


Request Body

Request Body

ToggleVcfEnvironmentDTO of type(s) application/json Required

toggleVcfEnvironmentDTO

{
    "productToLbMap": "{\"vrops\": \"vrops-lb.vsphere.local\", \"vra\": \"vra-lb.vsphere.local\"}"
}
string
productToLbMap Optional

Product to Load Balancer map


boolean
turnOffVcfEnabledEnvironment Optional
Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

200 OK

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

Request ID


201 Created

Created

Errors

Errors

GenericErrorResponseDTO
400

Bad Request


401

Unauthorized


403

Forbidden


GenericErrorResponseDTO
404

Not Found


GenericErrorResponseDTO
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"productToLbMap":"{\"vrops\": \"vrops-lb.vsphere.local\", \"vra\": \"vra-lb.vsphere.local\"}"}' https://localhost:8080/lcm/lcops/api/v2/environments/{environmentId}/toggleVcfEnvironment


Feedback

Was this page helpful?