NSX-T Data Center REST API

Set the cluster configuration for the Avi Load Balancer Controller node. The VIP can be set once. Attempting to change the VIP once set will return an error in case Avi Controllers are deployed.

Set the cluster configuration for Avi Load Balancer Controller cluster.

Request:

Method:

POST

URI Path(s):

/policy/api/v1/alb/controller-nodes/clusterconfig

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ALBControllerNodeVMClusterConfig+

ALBControllerNodeVMClusterConfig (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
cluster_ip	Cluster IP of Avi Load Balancer Controller cluster The cluster IP of the Avi Load Balancer Controller node cluster. This is mandatory parameter and required for single node controller deployments as well.	IPAddress	Required
cluster_name	Cluster name of Avi Load Balancer Controller cluster The cluster name of the Avi Load Balancer Controller cluster.	string
cluster_uuid	ID of the Avi Load Balancer Controller cluster used to recognize it ID of the Cluster maintained internally. This is different from cluster_uuid internal to Avi Load Balancer Controller. Note: This is automatically generated and cannot be modified.	string	Readonly
clustering_id	Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX.	string	Readonly
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
resource_type	Must be set to the value ALBControllerNodeVMClusterConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<policy-mgr>/policy/api/v1/alb/controller-nodes/clusterconfig { "cluster_ip" :"10.79.169.56", "cluster_name": "alb_controller_cluster", "clustering_id": "e8abab64-774e-48fa-bd5c-41df7aefdb88" }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ALBControllerNodeVMClusterConfig+

ALBControllerNodeVMClusterConfig (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
cluster_ip	Cluster IP of Avi Load Balancer Controller cluster The cluster IP of the Avi Load Balancer Controller node cluster. This is mandatory parameter and required for single node controller deployments as well.	IPAddress	Required
cluster_name	Cluster name of Avi Load Balancer Controller cluster The cluster name of the Avi Load Balancer Controller cluster.	string
cluster_uuid	ID of the Avi Load Balancer Controller cluster used to recognize it ID of the Cluster maintained internally. This is different from cluster_uuid internal to Avi Load Balancer Controller. Note: This is automatically generated and cannot be modified.	string	Readonly
clustering_id	Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX.	string	Readonly
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
resource_type	Must be set to the value ALBControllerNodeVMClusterConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "cluster_ip" :"10.79.169.56", "cluster_name": "alb_controller_cluster", "cluster_uuid" : "236d4061-5eb6-4b56-a87e-e9dc9eb2a291", "clustering_id": "e8abab64-774e-48fa-bd5c-41df7aefdb88" }

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