updateLoadBalancer
Update Load Balancer
Details
- Method:
PATCH - Path:
/load-balancers/{load-balancer-id} - Operation ID:
update-load-balancer
Parameters
{
"ssl": {
"description": "An SSL certificate to install on the Load Balancer.",
"required": false,
"location": "body",
"type": "object"
},
"sticky_session": {
"description": "Enables sticky sessions for your load balancer when a cookie_name is provided.",
"required": false,
"location": "body",
"type": "object"
},
"forwarding_rules": {
"description": "An array of forwarding rule objects.",
"required": false,
"location": "body",
"type": "array"
},
"health_check": {
"description": "The health check configuration. [See Load Balancer documentation](https://www.vultr.com/docs/vultr-load-balancers/#Load_Balancer_Configuration).",
"required": false,
"location": "body",
"type": "object"
},
"proxy_protocol": {
"description": "If `true`, you must configure backend nodes to accept Proxy protocol.\n\n* true\n* false (Default)",
"required": false,
"location": "body",
"type": "boolean"
},
"ssl_redirect": {
"description": "If `true`, this will redirect all HTTP traffic to HTTPS. You must have an HTTPS rule and SSL certificate installed on the load balancer to enable this option.\n\n* true\n* false",
"required": false,
"location": "body",
"type": "boolean"
},
"http2": {
"description": "If `true`, this will enable HTTP2 traffic. You must have an HTTPS forwarding rule combo (HTTPS -> HTTPS) to enable this option.\n\n* true\n* false",
"required": false,
"location": "body",
"type": "boolean"
},
"balancing_algorithm": {
"description": "The balancing algorithm.\n\n* roundrobin (default)\n* leastconn",
"required": false,
"location": "body",
"type": "string"
},
"instances": {
"description": "Send the complete array of Instances IDs that should be attached to this Load Balancer. Instances will be attached or detached to match your array. For example, if Instances **X**, **Y**, and **Z** are currently attached, and you send [A,B,Z], then Instance **A** and **B** will be attached, **X** and **Y** will be detached, and **Z** will remain attached.",
"required": false,
"location": "body",
"type": "array"
},
"label": {
"description": "The label for your Load Balancer",
"required": false,
"location": "body",
"type": "string"
},
"private_network": {
"description": "Use `vpc` instead. ID of the private network you wish to use. If private_network is omitted it will default to the public network.",
"required": false,
"location": "body",
"type": "string"
},
"vpc": {
"description": "ID of the VPC you wish to use. If a VPC ID is omitted it will default to the public network.",
"required": false,
"location": "body",
"type": "string"
},
"firewall_rules": {
"description": "An array of firewall rule objects.",
"required": false,
"location": "body",
"type": "array"
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('vultr')
# Call this tool
result = await agent.call_tool('updateLoadBalancer', {
# Add required parameters here
})