Apache CloudStack 4.23.0.0 Root Admin API Reference
listNetworkOfferings
Lists all available network offerings.
Request parameters
| Parameter Name | Description | Required |
| availability | The availability of network offering. Default value is required | false |
| displaytext | List network offerings by display text | false |
| domainid | List network offerings available for network creation in specific domain | false |
| forvpc | The network offering can be used only for network creation inside the VPC | false |
| guestiptype | List network offerings by guest type: shared or isolated | false |
| id | List network offerings by ID | false |
| isdefault | True if need to list only default network offerings. Default value is false | false |
| istagged | True if offering has tags specified | false |
| keyword | List by keyword | false |
| name | List network offerings by name | false |
| networkid | The ID of the network. Pass this in if you want to see the available network offering that a network can be changed to. | false |
| page | false | |
| pagesize | false | |
| routingmode | the routing mode for the network offering. Supported types are: Static or Dynamic. | false |
| sourcenatsupported | True if need to list only netwok offerings where source NAT is supported, false otherwise | false |
| specifyipranges | True if need to list only network offerings which support specifying ip ranges | false |
| specifyvlan | The tags for the network offering. | false |
| state | List network offerings by state | false |
| supportedservices | List network offerings supporting certain services | false |
| tags | List network offerings by tags | false |
| traffictype | List by traffic type | false |
| zoneid | List network offerings available for network creation in specific zone | false |
Response Tags
| Response Name | Description |
| id | The ID of the Network offering |
| availability | Availability of the Network offering |
| conservemode | True if Network offering is IP conserve mode enabled |
| created | The date this Network offering was created |
| details | Additional key/value details tied with network offering |
| displaytext | An alternate display text of the Network offering. |
| domain | The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| domainid | The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| egressdefaultpolicy | True if guest network default egress policy is allow; false if default egress policy is deny |
| fornsx | true if network offering can be used by NSX networks only |
| fortungsten | True if Network offering can be used by Tungsten-Fabric Networks only |
| forvpc | True if Network offering can be used by VPC Networks only |
| guestiptype | Guest type of the Network offering, can be Shared or Isolated |
| internetprotocol | The internet protocol of the network offering |
| isdefault | True if Network offering is default, false otherwise |
| ispersistent | True if Network offering supports persistent networks, false otherwise |
| maxconnections | Maximum number of concurrent connections to be handled by LB |
| name | The name of the Network offering |
| networkmode | Mode in which the network will operate. The valid values are NATTED and ROUTED |
| networkrate | Data transfer rate in megabits per second allowed. |
| routingmode | the routing mode for the network offering, supported types are Static or Dynamic. |
| serviceofferingid | The ID of the service offering used by virtual router provider |
| specifyasnumber | true if network offering supports choosing AS numbers |
| specifyipranges | True if Network offering supports specifying IP ranges, false otherwise |
| specifyvlan | True if Network offering supports VLANs, false otherwise |
| state | State of the Network offering. Can be Disabled/Enabled/Inactive |
| supportsinternallb | true if network offering supports public access for guest networks |
| supportspublicaccess | True if network offering supports public access for guest networks |
| supportsstrechedl2subnet | True if network offering supports network that span multiple zones |
| tags | The tags for the Network offering |
| traffictype | The traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage. |
| zone | The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| zoneid | The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| service(*) | The list of supported services |
| name | The service 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 |
| provider(*) | The service provider name |
| id | UUID of the Network provider |
| canenableindividualservice | True if individual services can be enabled/disabled |
| destinationphysicalnetworkid | The destination physical Network |
| name | The provider name |
| physicalnetworkid | The physical Network this belongs to |
| servicelist | Services for this provider |
| state | State of the Network provider |