NSX-T Data Center REST API

Onboards a compute VPC to be NSX managed by a transit VPC.

Onboard a compute VPC to be NSX managed using a transit VPC.
Hence, user can manage the workload VMs in a compute
VPC by the public cloud gateways deployed in a transit VPC.
Onboarding status can be obtained from
/csm/aws/compute-vpcs/<vpc-id>/status API. Upon successful onboarding
of the VPC, the onboard_step will be ONBOARD_SUCCESSFUL and op_status
will be NSX_MANAGED_BY_TRANSIT_VPC. If any error is encountered during
onboarding, corresponding error_code and error_message will be populated.
To manage compute VPC using NSX gateway, user needs to offboard the
compute VPC and deploy gateway using /csm/aws/gateways?action=deploy API.

Request:

Method:

POST

URI Path(s):

/api/v1/csm/aws/compute-vpcs/<vpc-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

AwsComputeVpcConfig+

AwsComputeVpcConfig (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
account_id	AWS Account ID AWS account ID related to the compute VPC. This field is deprecated. Field account_id can be learnt using vpc_id. GET /csm/aws/vpcs/ API returns associated_account_ids. Hence, this field is optional.	string	Deprecated
cloud_fallback_security_group_id	Id of Cloud Security Group Id of security group where the VMs should be moved after last gateway undeployed. This field is required only when default_quarantine_policy_enabled field is set to false.	string
configuration	AWS Transit VPC Configuration All the required informations regarding a transit VPC will be absorbed as a part of this field.	AwsTransitVpcConfig	Required
default_quarantine_policy_enabled	Flag to Identify if Default Quarantine Policy is Enabled Flag to convey if virtual machines belonging to the compute virtual private cloud should be quarantined or not.	boolean	Default: "False"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
managed_without_agents	Managed Without NSX Agents This flag determines if this compute virtual private cloud is managed with or without NSX agents.	boolean	Default: "False"
resource_type	Must be set to the value AwsComputeVpcConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-csm>/api/v1/csm/aws/compute-vpcs/ { "default_quarantine_policy_enabled": false, "managed_without_agents": false, "account_id": "fa043e3d-256d-446f-9c5c-665dcfdb33c9", "configuration": { "account_id": "fa043e3d-256d-446f-9c5c-665dcfdb33c9", "vpc_id": "vpc-560a242f" } }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

n/a

Required Permissions:

crud

Feature:

gateway_deployment

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable