Apache CloudStack 4.18.0.0 Root Admin API Reference
stopInternalLoadBalancerVM
Stops an Internal LB vm.
Request parameters
Parameter Name | Description | Required |
id | the ID of the internal lb vm | true |
forced | Force stop the VM. The caller knows the VM is stopped. | false |
Response Tags
Response Name | Description |
id | the id of the router |
account | the account associated with 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 |
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 link local 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 ipaddress |
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 upgrader |
role | role of the domain router |
scriptsversion | the version of scripts |
serviceofferingid | the ID of the service offering of the virtual machine |
serviceofferingname | the name of the service offering of the virtual machine |
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 |
success | result of the health check |
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 virtual machine |
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 VM |
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 |
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 |
secondaryip | the Secondary ipv4 addr of nic |
traffictype | the traffic type of the nic |
type | the type of the nic |
virtualmachineid | Id of the vm 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 |