Apache CloudStack 4.20.0.0 Root Admin API Reference
createLoadBalancerRule
Creates a load balancer rule
Request parameters
| Parameter Name | Description | Required |
| algorithm | load balancer algorithm (source, roundrobin, leastconn) | true |
| name | name of the load balancer rule | true |
| privateport | the private port of the private IP address/virtual machine where the network traffic will be load balanced to | true |
| publicport | the public port from where the network traffic will be load balanced from | true |
| account | the account associated with the load balancer. Must be used with the domainId parameter. | false |
| cidrlist | the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed. | false |
| description | the description of the load balancer rule | false |
| domainid | the domain ID associated with the load balancer | false |
| fordisplay | an optional field, whether to the display the rule to the end user or not | false |
| networkid | The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case) | false |
| openfirewall | if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true | false |
| protocol | The protocol for the LB such as tcp, udp or tcp-proxy. | false |
| publicipid | public IP address ID from where the network traffic will be load balanced from | false |
| zoneid | zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm | false |
Response Tags
| Response Name | Description |
| id | the load balancer rule ID |
| account | the account of the load balancer rule |
| algorithm | the load balancer algorithm (source, roundrobin, leastconn) |
| cidrlist | the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). |
| description | the description of the load balancer |
| domain | the domain of the load balancer rule |
| domainid | the domain ID of the load balancer rule |
| domainpath | path of the domain to which the load balancer rule belongs |
| fordisplay | is rule for display to the regular user |
| name | the name of the load balancer |
| networkid | the id of the guest network the lb rule belongs to |
| privateport | the private port |
| project | the project name of the load balancer |
| projectid | the project id of the load balancer |
| protocol | the protocol of the loadbalanacer rule |
| publicip | the public ip address |
| publicipid | the public ip address id |
| publicport | the public port |
| state | the state of the rule |
| zoneid | the id of the zone the rule belongs to |
| zonename | the name of the zone the load balancer rule belongs to |
| tags(*) | the list of resource tags associated with load balancer |
| account | the account associated with the tag |
| customer | customer associated with the tag |
| domain | the domain associated with the tag |
| domainid | the ID of the domain associated with the tag |
| domainpath | path of the Domain associated with the tag |
| key | tag key name |
| project | the project name where tag belongs to |
| projectid | the project id the tag belongs to |
| resourceid | id of the resource |
| resourcetype | resource type |
| value | tag value |