New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_http_method |
|
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.
|
|
display_text |
Display text of the vpc offerings
|
|
name
required |
The name of the vpc offering
|
|
poll_async |
Default: yes
|
Poll async jobs until job has finished.
|
service_capabilities |
Desired service capabilities as part of vpc offering.
aliases: service_capability |
|
service_offering |
The name or ID of the service offering for the VPC router appliance.
|
|
service_providers |
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 |
|
state |
|
State of the vpc offering.
|
supported_services |
Services supported by the vpc offering
aliases: supported_service |
Note
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.# Create a vpc offering and enable it
- local_action:
module: cs_vpc_offering
name: "my_vpc_offering"
display_text: "vpc offering description"
state: enabled
supported_services: [ Dns, Dhcp ]
service_providers:
- {service: 'dns', provider: 'virtualrouter'}
- {service: 'dhcp', provider: 'virtualrouter'}
# Remove a vpc offering
- local_action:
module: cs_vpc_offering
name: "my_vpc_offering"
state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
display_text
string
|
success |
The display text of the vpc offering
Sample:
My vpc offering
|
distributed
bool
|
success |
Indicates if the vpc offering supports distributed router for one-hop forwarding.
|
id
string
|
success |
UUID of the vpc offering.
Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
|
is_default
bool
|
success |
Whether VPC offering is the default offering or not.
|
name
string
|
success |
The name of the vpc offering
Sample:
MyCustomVPCOffering
|
region_level
bool
|
success |
Indicated if the offering can support region level vpc.
|
service_offering_id
string
|
success |
The service offering ID.
Sample:
c5f7a5fc-43f8-11e5-a151-feff819cdc9f
|
state
string
|
success |
The state of the vpc offering
Sample:
Enabled
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.