NSX-T Data Center REST API

VirtualPrivateCloudStatus (schema)

Virtual Private Cloud Status

Stores the information related to onboard and offboard status of virtual private cloud.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
error_code Error Code

Error code related to virtual private cloud
Onboard/Offboard failure.
integer Readonly
error_message Error Message

Error message related to virtual private cloud
Onboard/Offboard failure.
string Readonly
offboard_step States of Virtual Private Cloud While OffBoard

Stores the different states of virtual private cloud while
offboarding from a transit virtual private cloud.
string Readonly
Enum: UNCONFIGURING_GATEWAY, DELETING_SECURITY_GROUPS, OFFBOARD_SUCCESSFUL, OFFBOARD_FAILED, NOT_APPLICABLE
onboard_step States of Virtual Private Cloud While Onboard

Stores the different states of virtual private cloud while
onboarding using a transit virtual private cloud.
string Readonly
Enum: VALIDATING_ENVIRONMENT, CREATING_SECURITY_GROUPS, CONFIGURING_GATEWAY, ONBOARD_SUCCESSFUL, ONBOARD_FAILED, NOT_APPLICABLE
status Virtual Private Cloud Status

Indicates the status of a virtual private cloud.
UP: virtual private cloud is NSX managed.
DOWN: virtual private cloud is NSX managed with errors.
ONBOARDING: virtual private cloud is in the process of
onboarding using a transit virtual private cloud.
OFFBOARDING: virtual private cloud is in the process of
offboarding from a transit virtual private cloud.
NOT_APPLICABLE: virtual private cloud is NSX unmanaged.
string Readonly
Enum: UP, DOWN, ONBOARDING, OFFBOARDING, NOT_APPLICABLE
virtual_private_cloud_name Virtual Private Cloud Name

Name of the transit virtual private cloud.
string Readonly