Update a Advanced Load Balancer controller cluster node VM. Only updating password, ntp and dns servers are supported. If controller is in a cluster then all nodes in the cluster are updated with the provided values

Update Advanced Load Balancer Controller node VM details

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/alb/controller-nodes/deployments/<node-id>

Request Headers:

n/a

Query Parameters:

ALBControllerNodeVMUpdateParameters+

Name	Description	Type	Notes
running_config	Update Advanced Load Balancer Controller runtime config as well If true, then the configuration will be updated in the running Advanced Load Balancer Controllers as well.	boolean

Request Body:

ALBControllerNodeVMDeploymentRequest+

ALBControllerNodeVMDeploymentRequest (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
deployment_config	Deployment config for Advanced Load Balancer controller node VM Deployment information and basic configuration for the Advanced Load Balancer controller.	ALBControllerNodeVMDeploymentConfig (Abstract type: pass one of the following concrete types) AlbControllerVsphereClusterNodeVmDeploymentConfig	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
form_factor	Form factor for Advanced Load Balancer controller VMs. Specifies the desired "size" of the VM	ALBControllerClusterNodeVMFormFactor	Default: "MEDIUM"
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value ALBControllerNodeVMDeploymentRequest	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
user_settings	User settings for the VM SSH key and password for the Advanced Load Balancer controller node VM. Note: SSH key settings will be honored only during VM deployment.	ALBControllerNodeUserSettings	Required
vm_id	ID of Advanced Load Balancer controller VM used to recognize it ID of the VM maintained internally. Note: This is automatically generated and cannot be modified.	string	Readonly

Example Request:

PUT https://<policy-mgr>/policy/api/v1/alb/controller-nodes/deployments/71f02260-644f-4482-aa9a-ab8570bb49a3 { "form_factor": "SMALL", "user_settings": { "admin_password": "Pass@1234!", }, "deployment_config": { "vc_id": "3d3ad89a-bee5-41ef-927f-68ee86e84d70", "compute_id": "domain-c7", "host_id": null, "storage_id": "datastore-13", "management_network_id": "network-14", "hostname": "controller-1", "placement_type": "AlbControllerVsphereClusterNodeVmDeploymentConfig", "disk_provisioning": "THIN", "dns_servers": [ "10.107.0.2" ], "ntp_servers": [ "10.166.1.110" ] } }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ALBControllerNodeVMDeploymentRequest+

ALBControllerNodeVMDeploymentRequest (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
deployment_config	Deployment config for Advanced Load Balancer controller node VM Deployment information and basic configuration for the Advanced Load Balancer controller.	ALBControllerNodeVMDeploymentConfig (Abstract type: pass one of the following concrete types) AlbControllerVsphereClusterNodeVmDeploymentConfig	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
form_factor	Form factor for Advanced Load Balancer controller VMs. Specifies the desired "size" of the VM	ALBControllerClusterNodeVMFormFactor	Default: "MEDIUM"
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value ALBControllerNodeVMDeploymentRequest	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
user_settings	User settings for the VM SSH key and password for the Advanced Load Balancer controller node VM. Note: SSH key settings will be honored only during VM deployment.	ALBControllerNodeUserSettings	Required
vm_id	ID of Advanced Load Balancer controller VM used to recognize it ID of the VM maintained internally. Note: This is automatically generated and cannot be modified.	string	Readonly

Example Response:

{ "results": [ { "vm_id": "51a41c72-5f9e-48c1-9eb4-e3d6582813e0", "form_factor": "SMALL", "deployment_config": { "vc_id": "3d3ad89a-bee5-41ef-927f-68ee86e84d70", "compute_id": "domain-c7", "storage_id": "datastore-13", "management_network_id": "network-14", "ntp_servers": [ "10.166.1.110" ], "dns_servers": [ "10.107.0.2" ], "hostname": "controller-1", "disk_provisioning": "THIN", "placement_type": "AlbControllerVsphereClusterNodeVmDeploymentConfig" } } ], "result_count": 1 }

Update a Advanced Load Balancer controller cluster node VM. Only updating password, ntp and dns servers are supported. If controller is in a cluster then all nodes in the cluster are updated with the provided values

Request:

ALBControllerNodeVMUpdateParameters (schema)

ALBControllerNodeVMDeploymentRequest (schema)

Example Request:

Successful Response:

ALBControllerNodeVMDeploymentRequest (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: