Apache CloudStack 4.15.0.0 Root Admin API Reference

createNetworkOffering

Creates a network offering.

Request parameters

Parameter NameDescriptionRequired
displaytextthe display text of the network offeringtrue
guestiptypeguest type of the network offering: Shared or Isolatedtrue
namethe name of the network offeringtrue
supportedservicesservices supported by the network offeringtrue
traffictypethe traffic type for the network offering. Supported type in current release is GUEST onlytrue
availabilitythe availability of network offering. Default value is Optionalfalse
conservemodetrue if the network offering is IP conserve mode enabledfalse
detailsNetwork offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroupfalse
domainidthe ID of the containing domain(s), null for public offeringsfalse
egressdefaultpolicytrue if guest network default egress policy is allow; false if default egress policy is denyfalse
forvpctrue if network offering is meant to be used for VPC, false otherwise.false
ispersistenttrue if network offering supports persistent networks; defaulted to false if not specifiedfalse
keepaliveenabledif true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.false
maxconnectionsmaximum number of concurrent connections supported by the network offeringfalse
networkratedata transfer rate in megabits per second allowedfalse
servicecapabilitylistdesired service capabilities as part of network offeringfalse
serviceofferingidthe service offering ID used by virtual router providerfalse
serviceproviderlistprovider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical networkfalse
specifyiprangestrue if network offering supports specifying ip ranges; defaulted to false if not specifiedfalse
specifyvlantrue if network offering supports vlansfalse
tagsthe tags for the network offering.false
zoneidthe ID of the containing zone(s), null for public offeringsfalse

Response Tags

Response NameDescription
idthe id of the network offering
availabilityavailability of the network offering
conservemodetrue if network offering is ip conserve mode enabled
createdthe date this network offering was created
detailsadditional key/value details tied with network offering
displaytextan alternate display text of the network offering.
domainthe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidthe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
egressdefaultpolicytrue if guest network default egress policy is allow; false if default egress policy is deny
forvpctrue if network offering can be used by VPC networks only
guestiptypeguest type of the network offering, can be Shared or Isolated
isdefaulttrue if network offering is default, false otherwise
ispersistenttrue if network offering supports persistent networks, false otherwise
maxconnectionsmaximum number of concurrents connections to be handled by lb
namethe name of the network offering
networkratedata transfer rate in megabits per second allowed.
serviceofferingidthe ID of the service offering used by virtual router provider
specifyiprangestrue if network offering supports specifying ip ranges, false otherwise
specifyvlantrue if network offering supports vlans, false otherwise
statestate of the network offering. Can be Disabled/Enabled/Inactive
supportspublicaccesstrue if network offering supports public access for guest networks
supportsstrechedl2subnettrue if network offering supports network that span multiple zones
tagsthe tags for the network offering
traffictypethe traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.
zonethe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidthe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
service(*)the list of supported 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