Apache CloudStack 4.18.0.0 Root Admin API Reference

listRouters

List routers.

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
clusteridthe cluster ID of the routerfalse
domainidlist only resources belonging to the domain specifiedfalse
fetchhealthcheckresultsif true is passed for this parameter, also fetch last executed health check results for the router. Default is falsefalse
forvpcif true is passed for this parameter, list only VPC routersfalse
healthchecksfailedif this parameter is passed, list only routers by health check resultsfalse
hostidthe host ID of the routerfalse
idthe ID of the disk routerfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
namethe name of the routerfalse
networkidlist by network idfalse
pagefalse
pagesizefalse
podidthe Pod ID of the routerfalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
statethe state of the routerfalse
versionlist virtual router elements by versionfalse
vpcidList networks by VPCfalse
zoneidthe Zone ID of the routerfalse

Response Tags

Response NameDescription
idthe id of the router
accountthe account associated with the router
createdthe date and time the router was created
dns1the first DNS for the router
dns2the second DNS for the router
domainthe domain associated with the router
domainidthe domain ID associated with the router
gatewaythe gateway for the router
guestipaddressthe guest IP address for the router
guestmacaddressthe guest MAC address for the router
guestnetmaskthe guest netmask for the router
guestnetworkidthe ID of the corresponding guest network
guestnetworknamethe name of the corresponding guest network
healthchecksfailedtrue if any health checks had failed
hostcontrolstatethe control state of the host for the router
hostidthe host ID for the router
hostnamethe hostname for the router
hypervisorthe hypervisor on which the template runs
ip6dns1the first IPv6 DNS for the router
ip6dns2the second IPv6 DNS for the router
isredundantrouterif this router is an redundant virtual router
linklocalipthe link local IP address for the router
linklocalmacaddressthe link local MAC address for the router
linklocalnetmaskthe link local netmask for the router
linklocalnetworkidthe ID of the corresponding link local network
namethe name of the router
networkdomainthe network domain for the router
podidthe Pod ID for the router
podnamethe Pod name for the router
projectthe project name of the address
projectidthe project id of the ipaddress
publicipthe public IP address for the router
publicmacaddressthe public MAC address for the router
publicnetmaskthe public netmask for the router
publicnetworkidthe ID of the corresponding public network
redundantstatethe state of redundant virtual router
requiresupgradetrue if the router template requires upgrader
rolerole of the domain router
scriptsversionthe version of scripts
serviceofferingidthe ID of the service offering of the virtual machine
serviceofferingnamethe name of the service offering of the virtual machine
softwareversionthe version of the code / software in the router
statethe state of the router
templateidthe template ID for the router
templatenamethe template name for the router
versionthe version of template
vpcidVPC the router belongs to
vpcnamethe name of VPC the router belongs to
zoneidthe Zone ID for the router
zonenamethe Zone name for the router
healthcheckresults(*)Last executed health check result for the router
checknamethe name of the health check on the router
checktypethe type of the health check - basic or advanced
detailsdetailed response generated on running health check
lastupdatedthe date this VPC was created
successresult of the health check
nic(*)the list of nics associated with the router
idthe ID of the nic
adaptertypeType of adapter if available
broadcasturithe broadcast uri of the nic
deviceiddevice id for the network when plugged into the virtual machine
extradhcpoptionthe extra dhcp options on the nic
gatewaythe gateway of the nic
ip6addressthe IPv6 address of network
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
ipaddressthe ip address of the nic
ipaddressesIP addresses associated with NIC found for unmanaged VM
isdefaulttrue if nic is default, false otherwise
isolatedpvlanthe isolated private VLAN if available
isolatedpvlantypethe isolated private VLAN type if available
isolationurithe isolation uri of the nic
macaddresstrue if nic is default, false otherwise
mtuMTU configured on the NIC
netmaskthe netmask of the nic
networkidthe ID of the corresponding network
networknamethe name of the corresponding network
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryipthe Secondary ipv4 addr of nic
traffictypethe traffic type of the nic
typethe type of the nic
virtualmachineidId of the vm to which the nic belongs
vlanidID of the VLAN/VNI if available
vpcidId of the vpc to which the nic belongs
vpcnamename of the vpc to which the nic belongs