Apache CloudStack 4.23.0.0 Root Admin API Reference
stopInternalLoadBalancerVM
Stops an Internal LB Instance.
Request parameters
| Parameter Name | Description | Required |
| id | The ID of the internal LB Instance | true |
| forced | Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such. | false |
Response Tags
| Response Name | Description |
| id | The ID of the router |
| account | The Account associated with the router |
| arch | CPU arch of the router |
| created | The date and time the router was created |
| dns1 | The first DNS for the router |
| dns2 | The second DNS for the router |
| domain | The domain associated with the router |
| domainid | The domain ID associated with the router |
| domainpath | path of the Domain the router belongs to |
| gateway | The gateway for the router |
| guestipaddress | The guest IP address for the router |
| guestmacaddress | The guest MAC address for the router |
| guestnetmask | The guest netmask for the router |
| guestnetworkid | The ID of the corresponding guest Network |
| guestnetworkname | The name of the corresponding guest Network |
| healthchecksfailed | True if any health checks had failed |
| hostcontrolstate | The control state of the host for the router |
| hostid | The host ID for the router |
| hostname | The hostname for the router |
| hypervisor | The hypervisor on which the Template runs |
| ip6dns1 | The first IPv6 DNS for the router |
| ip6dns2 | The second IPv6 DNS for the router |
| isredundantrouter | If this router is an redundant virtual router |
| linklocalip | The Control IP address for the router |
| linklocalmacaddress | The link local MAC address for the router |
| linklocalnetmask | The link local netmask for the router |
| linklocalnetworkid | The ID of the corresponding link local Network |
| name | The name of the router |
| networkdomain | The Network domain for the router |
| podid | The Pod ID for the router |
| podname | The Pod name for the router |
| project | The project name of the address |
| projectid | The project id of the IP address |
| publicip | The public IP address for the router |
| publicmacaddress | The public MAC address for the router |
| publicnetmask | The public netmask for the router |
| publicnetworkid | The ID of the corresponding public Network |
| redundantstate | The state of redundant virtual router |
| requiresupgrade | True if the router Template requires upgrade |
| role | Role of the domain router |
| scriptsversion | The version of scripts |
| serviceofferingid | The ID of the service offering of the Instance |
| serviceofferingname | The name of the service offering of the Instance |
| softwareversion | The version of the code / software in the router |
| state | The state of the router |
| templateid | The Template ID for the router |
| templatename | The Template name for the router |
| version | The version of Template |
| vpcid | VPC the router belongs to |
| vpcname | The name of VPC the router belongs to |
| zoneid | The Zone ID for the router |
| zonename | The Zone name for the router |
| healthcheckresults(*) | Last executed health check result for the router |
| checkname | The name of the health check on the router |
| checktype | The type of the health check - basic or advanced |
| details | Detailed response generated on running health check |
| lastupdated | The date this VPC was created |
| status | the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN} |
| success | The result of the health check if available |
| nic(*) | The list of NICs associated with the router |
| id | The ID of the NIC |
| adaptertype | Type of adapter if available |
| broadcasturi | The broadcast URI of the NIC |
| deviceid | Device ID for the Network when plugged into the Instance |
| enabled | whether the NIC is enabled or not |
| extradhcpoption | The extra DHCP options on the NIC |
| gateway | The gateway of the NIC |
| ip6address | The IPv6 address of Network |
| ip6cidr | The CIDR of IPv6 Network |
| ip6gateway | The gateway of IPv6 Network |
| ipaddress | The IP address of the NIC |
| ipaddresses | IP addresses associated with NIC found for unmanaged Instance |
| isdefault | True if NIC is default, false otherwise |
| isolatedpvlan | The isolated private VLAN if available |
| isolatedpvlantype | The isolated private VLAN type if available |
| isolationuri | The isolation URI of the NIC |
| macaddress | True if NIC is default, false otherwise |
| mtu | MTU configured on the NIC |
| netmask | The netmask of the NIC |
| networkid | The ID of the corresponding Network |
| networkname | The name of the corresponding Network |
| nicdnsname | DNS name associated with this NIC's IP address |
| nsxlogicalswitch | Id of the NSX Logical Switch (if NSX based), null otherwise |
| nsxlogicalswitchport | Id of the NSX Logical Switch Port (if NSX based), null otherwise |
| publicip | Public IP address associated with this NIC via Static NAT rule |
| publicipid | Public IP address ID associated with this NIC via Static NAT rule |
| secondaryip | The Secondary IPv4 addr of NIC |
| traffictype | The traffic type of the NIC |
| type | The type of the NIC |
| virtualmachineid | Id of the Instance to which the NIC belongs |
| vlanid | ID of the VLAN/VNI if available |
| vpcid | ID of the VPC to which the NIC belongs |
| vpcname | Name of the VPC to which the NIC belongs |