NSX-T Data Center REST API

This is Post Controller Deployment Workflow. It will create role if not exist Create Service User Set System Configuration Create Enforcement Point Save Infra-Admin Creds to DB.

Set the post deployment cluster configuration for Advanced Load Balancer controller cluster.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/infra/alb-onboarding-workflow

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ALBControllerConfiguration+

ALBControllerConfiguration (schema)

Name	Description	Type	Notes
cluster_ip	Cluster IP of Advanced Load Balancer controller cluster The cluster IP of the Advanced Load Balancer controller node cluster. This is mandatory parameter and required for single node controller deployments as well.	IPAddress	Required
dns_servers	DNS servers. List of DNS servers.	array of IPv4Address
infra_admin_password	Advanced Load Balancer controller admin password Password for the controller node admin user. For deployment, this property is required. The password specified must be at least 8 characters in length.	string	Required
infra_admin_username	Username Username for server authentication.	string	Required
ntp_servers	NTP servers. List of NTP servers.	array of HostnameOrIPv4Address
owned_by	owned_by The policy initiates workflow by LCM/VCF	string	Required Enum: LCM, VCF

Example Request:

PUT https://<policy-mgr>/policy/api/v1/infra/alb-onboarding-workflow { "owned_by":"LCM", "cluster_ip" :"10.79.169.56", "infra_admin_username" : "admin", "infra_admin_password" : "Admin!23", "ntp_servers": [ "time.vmware.com" ], "dns_servers": [ "10.107.0.2" ] }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

EnforcementPoint+

EnforcementPoint (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
auto_enforce	Auto Enforce Flag Auto enforce flag suggests whether the policy objects shall be automatically enforced on this enforcement point or not. When this flag is set to true, all policy objects will be automatically enforced on this enforcement point. If this flag is set to false, user shall rely on the usual means of realization, i.e., deployment maps.	boolean	Default: "True"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildClusterControlPlane ChildHostTransportNode ChildHostTransportNodeCollection ChildPolicyEdgeCluster ChildPolicyTransportZone
connection_info	Enforcement Point Connection Info Connection Info of the Enforcement Point.	EnforcementPointConnectionInfo (Abstract type: pass one of the following concrete types) AviConnectionInfo CvxConnectionInfo NSXTConnectionInfo NSXVConnectionInfo	Required
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
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated thier unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value EnforcementPoint	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
version	Enforcement point Version Version of the Enforcement point.	string	Readonly

Example Response:

{ "connection_info": { "username": "nsxt-alb", "tenant": "admin", "expires_at": "2021-08-30T23:47:58.275Z", "enforcement_point_address": "10.92.60.188", "resource_type": "AviConnectionInfo" }, "auto_enforce": true, "resource_type": "EnforcementPoint", "id": "alb-endpoint", "display_name": "alb-endpoint", "path": "/infra/sites/default/enforcement-points/alb-endpoint", "relative_path": "alb-endpoint", "parent_path": "/infra/sites/default", "unique_id": "1ae2d4e8-9019-4ca4-840c-d0b42b4843bd", "realization_id": "1ae2d4e8-9019-4ca4-840c-d0b42b4843bd", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_create_user": "admin", "_create_time": 1630345678736, "_last_modified_user": "admin", "_last_modified_time": 1630345678736, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

crud

Feature:

policy_lb

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