Documentation

cs_network_offering - Manages network offerings on Apache CloudStack based clouds.

New in version 2.5.

Synopsis

  • Create, update, enable, disable and remove network offerings.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • cs >= 0.6.10

Parameters

Parameter Choices/Defaults Comments
api_http_method
    Choices:
  • get
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is get if not specified.
api_key
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_region Default:
cloudstack
Name of the ini section in the cloustack.ini file.
If not given, the CLOUDSTACK_REGION env variable is considered.
api_secret
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_timeout
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
api_url
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
availability
The availability of network offering. Default value is Optional
conserve_mode
bool
    Choices:
  • no
  • yes
Whether the network offering has IP conserve mode enabled.
details
    Choices:
  • internallbprovider
  • publiclbprovider
Network offering details in key/value pairs.
with service provider as a value
display_text
Display text of the network offerings.
egress_default_policy
    Choices:
  • allow
  • deny
Whether the default egress policy is allow or to deny.
guest_ip_type
    Choices:
  • Shared
  • Isolated
Guest type of the network offering.
keepalive_enabled
bool
    Choices:
  • no
  • yes
If 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.
max_connections
Maximum number of concurrent connections supported by the network offering.
name
required
The name of the network offering.
network_rate
Data transfer rate in megabits per second allowed.
persistent
True if network offering supports persistent networks
defaulted to false if not specified
service_capabilities
Desired service capabilities as part of network offering.

aliases: service_capability
service_offering
The service offering name or ID used by virtual router provider.
service_provider
Provider to service mapping.
If not specified, the provider for the service will be mapped to the default provider on the physical network.

aliases: service_provider
specify_ip_ranges
bool
    Choices:
  • no
  • yes
Wheter the network offering supports specifying IP ranges.
Defaulted to no by the API if not specified.
specify_vlan
bool
    Choices:
  • no
  • yes
Whether the network offering supports vlans or not.
state
    Choices:
  • enabled
  • present ←
  • disabled
  • absent
State of the network offering.
supported_services
    Choices:
  • Dns
  • PortForwarding
  • Dhcp
  • SourceNat
  • UserData
  • Firewall
  • StaticNat
  • Vpn
  • Lb
Services supported by the network offering.
One or more of the choices.

aliases: supported_service
traffic_type Default:
Guest
The traffic type for the network offering.

Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. A CLOUDSTACK_CONFIG environment variable pointing to an .ini file. A cloudstack.ini file in the current working directory. A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: Create a network offering and enable it
  local_action:
    module: cs_network_offering
    name: my_network_offering
    display_text: network offering description
    state: enabled
    guest_ip_type: Isolated
    supported_services: [ Dns, PortForwarding, Dhcp, SourceNat, UserData, Firewall, StaticNat, Vpn, Lb ]
    service_providers:
      - { service: 'dns', provider: 'virtualrouter' }
      - { service: 'dhcp', provider: 'virtualrouter' }


- name: Remove a network offering
  local_action:
    module: cs_network_offering
    name: my_network_offering
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
availability
string
success
The availability of network offering.

Sample:
Optional
display_text
string
success
The display text of the network offering.

Sample:
My network offering
egress_default_policy
string
success
Default egress policy.

Sample:
allow
guest_ip_type
string
success
Guest type of the network offering.

Sample:
Isolated
id
string
success
UUID of the network offering.

Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
is_default
bool
success
Whether network offering is the default offering or not.

is_persistent
bool
success
Whether persistent networks are supported or not.

max_connections
int
success
The maximum number of concurrents connections to be handled by LB.

Sample:
300
name
string
success
The name of the network offering.

Sample:
MyCustomNetworkOffering
network_rate
int
success
The network traffic transfer ate in Mbit/s.

Sample:
200
service_offering_id
string
success
The service offering ID.

Sample:
c5f7a5fc-43f8-11e5-a151-feff819cdc9f
state
string
success
The state of the network offering.

Sample:
Enabled
traffic_type
string
success
The traffic type.

Sample:
Guest


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • David Passante (@dpassante)

Hint

If you notice any issues in this documentation you can edit this document to improve it.