Apache CloudStack 4.20.0.0 Root Admin API Reference

listBrocadeVcsDeviceNetworks

lists network that are using a brocade vcs switch

Request parameters

Parameter NameDescriptionRequired
vcsdeviceidbrocade vcs switch IDtrue
keywordList by keywordfalse
pagefalse
pagesizefalse

Response Tags

Response NameDescription
idthe id of the network
accountthe owner of the network
aclidACL Id associated with the VPC network
aclnameACL name associated with the VPC network
acltypeacl type - access type to the network
asnumberAS NUMBER
asnumberidUUID of AS NUMBER
associatednetworkthe name of the Network associated with this network
associatednetworkidthe ID of the Network associated with this network
bgppeersThe BGP peers for the network
broadcastdomaintypeBroadcast domain type of the network
broadcasturibroadcast uri of the network. This parameter is visible to ROOT admins only
canusefordeploylist networks available for vm deployment
cidrCloudstack managed address space, all CloudStack managed VMs get IP address from CIDR
createdthe date this network was created
detailsthe details of the network
displaynetworkan optional field, whether to the display the network to the end user or not.
displaytextthe displaytext of the network
dns1the first IPv4 DNS for the network
dns2the second IPv4 DNS for the network
domainthe domain name of the network owner
domainidthe domain id of the network owner
domainpathpath of the Domain the network belongs to
egressdefaultpolicytrue if guest network default egress policy is allow; false if default egress policy is deny
externalidThe external id of the network
gatewaythe network's gateway
iconBase64 string representation of the resource icon
internetprotocolThe internet protocol of network offering
ip4routesThe routes for the network to ease adding route in upstream router
ip4routingThe IPv4 routing type of network
ip6cidrthe cidr of IPv6 network
ip6dns1the first IPv6 DNS for the network
ip6dns2the second IPv6 DNS for the network
ip6gatewaythe gateway of IPv6 network
ip6routesThe routes for the network to ease adding route in upstream router
ip6routingThe Ipv6 routing type of network offering
isdefaulttrue if network is default, false otherwise
ispersistentlist networks that are persistent
issystemtrue if network is system, false otherwise
namethe name of the network
netmaskthe network's netmask
networkcidrthe network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
networkdomainthe network domain
networkofferingavailabilityavailability of the network offering the network is created from
networkofferingconservemodetrue if network offering is ip conserve mode enabled
networkofferingdisplaytextdisplay text of the network offering the network is created from
networkofferingidnetwork offering id the network is created from
networkofferingnamename of the network offering the network is created from
physicalnetworkidthe physical network id
privatemtuMTU configured on the network VR's private interfaces
projectthe project name of the address
projectidthe project id of the ipaddress
publicmtuMTU configured on the network VR's public facing interfaces
receivedbytesthe total number of network traffic bytes received
redundantrouterIf the network has redundant routers enabled
relatedrelated to what other network configuration
reservediprangethe network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes
restartrequiredtrue network requires restart
sentbytesthe total number of network traffic bytes sent
specifyiprangestrue if network supports specifying ip ranges, false otherwise
statestate of the network
strechedl2subnettrue if network can span multiple zones
subdomainaccesstrue if users from subdomains can access the domain level network
supportsvmautoscalingif network offering supports vm autoscaling feature
traffictypethe traffic type of the network
tungstenvirtualrouteruuidTungsten-Fabric virtual router the network belongs to
typethe type of the network
vlanThe vlan of the network. This parameter is visible to ROOT admins only
vpcidVPC the network belongs to
vpcnameName of the VPC to which this network belongs
zoneidzone id of the network
zonenamethe name of the zone the network belongs to
zonesnetworkspansIf a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans
service(*)the list of services
namethe service name
capability(*)the list of capabilities
canchooseservicecapabilitycan this service capability value can be choosable while creatine network offerings
namethe capability name
valuethe capability value
provider(*)the service provider name
iduuid of the network provider
canenableindividualservicetrue if individual services can be enabled/disabled
destinationphysicalnetworkidthe destination physical network
namethe provider name
physicalnetworkidthe physical network this belongs to
servicelistservices for this provider
statestate of the network provider
tags(*)the list of resource tags associated with network
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
domainpathpath of the Domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value