Apache CloudStack 4.0.0-incubating Domain Admin API Reference
listNetworks
Lists all available networks.
Request parameters
| Parameter Name | Description | Required |
| account | List resources by account. Must be used with the domainId parameter. | false |
| acltype | list networks by ACL (access control list) type. Supported values are Account and Domain | false |
| canusefordeploy | list networks available for vm deployment | false |
| domainid | list only resources belonging to the domain specified | false |
| forvpc | the network belongs to vpc | false |
| id | list networks by id | false |
| isrecursive | defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| issystem | true if network is system, false otherwise | false |
| keyword | List by keyword | false |
| listall | If 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 | false |
| page | false | |
| pagesize | false | |
| physicalnetworkid | list networks by physical network id | false |
| projectid | list objects by project | false |
| restartrequired | list networks by restartRequired | false |
| specifyipranges | true if need to list only networks which support specifying ip ranges | false |
| supportedservices | list networks supporting certain services | false |
| tags | List resources by tags (key/value pairs) | false |
| traffictype | type of the traffic | false |
| type | the type of the network. Supported values are: Isolated and Shared | false |
| vpcid | List networks by VPC | false |
| zoneid | the Zone ID of the network | false |
Response Tags
| Response Name | Description |
| id | the id of the network |
| account | the owner of the network |
| acltype | acl type - access type to the network |
| broadcastdomaintype | Broadcast domain type of the network |
| broadcasturi | broadcast uri of the network |
| canusefordeploy | list networks available for vm deployment |
| cidr | the cidr the network |
| displaytext | the displaytext of the network |
| dns1 | the first DNS for the network |
| dns2 | the second DNS for the network |
| domain | the domain name of the network owner |
| domainid | the domain id of the network owner |
| gateway | the network's gateway |
| isdefault | true if network is default, false otherwise |
| issystem | true if network is system, false otherwise |
| name | the name of the network |
| netmask | the network's netmask |
| networkdomain | the network domain |
| networkofferingavailability | availability of the network offering the network is created from |
| networkofferingdisplaytext | display text of the network offering the network is created from |
| networkofferingid | network offering id the network is created from |
| networkofferingname | name of the network offering the network is created from |
| physicalnetworkid | the physical network id |
| project | the project name of the address |
| projectid | the project id of the ipaddress |
| related | related to what other network configuration |
| restartrequired | true network requires restart |
| specifyipranges | true if network supports specifying ip ranges, false otherwise |
| state | state of the network |
| subdomainaccess | true if users from subdomains can access the domain level network |
| traffictype | the traffic type of the network |
| type | the type of the network |
| vlan | the vlan of the network |
| vpcid | VPC the network belongs to |
| zoneid | zone id of the network |
| zonename | the name of the zone the network belongs to |
| service(*) | the list of services |
| name | the service name |
| provider | the service provider name |
| capability(*) | the list of capabilities |
| canchooseservicecapability | can this service capability value can be choosable while creatine network offerings |
| name | the capability name |
| value | the capability value |
| tags(*) | the list of resource tags associated with network |
| 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 |
| 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 |