New in version 2.0.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
account
string
|
Account the static NAT is related to.
|
|
|
api_http_method
string
|
|
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
string
|
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
string
|
Default: "cloudstack"
|
Name of the ini section in the
cloustack.ini file.If not given, the
CLOUDSTACK_REGION env variable is considered. |
|
api_secret
string
|
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
integer
|
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
string
|
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.
|
|
|
domain
string
|
Domain the static NAT is related to.
|
|
|
ip_address
string
/ required
|
Public IP address the static NAT is assigned to.
|
|
|
network
string
added in 2.2 |
Network the IP address is related to.
|
|
|
poll_async
boolean
|
|
Poll async jobs until job has finished.
|
|
project
string
|
Name of the project the static NAT is related to.
|
|
|
state
string
|
|
State of the static NAT.
|
|
vm
string
|
Name of virtual machine which we make the static NAT for.
Required if state=present.
|
|
|
vm_guest_ip
string
|
VM guest NIC secondary IP address for the static NAT.
|
|
|
vpc
string
added in 2.3 |
VPC the network related to.
|
|
|
zone
string
|
Name of the zone in which the virtual machine is in.
If not set, default zone is used.
|
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.- name: Create a static NAT for IP 1.2.3.4 to web01
cs_staticnat:
ip_address: 1.2.3.4
vm: web01
delegate_to: localhost
- name: Remove a static NAT
cs_staticnat:
ip_address: 1.2.3.4
state: absent
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
account
string
|
success |
Account the static NAT is related to.
Sample:
example account
|
|
domain
string
|
success |
Domain the static NAT is related to.
Sample:
example domain
|
|
id
string
|
success |
UUID of the ip_address.
Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
|
|
ip_address
string
|
success |
Public IP address.
Sample:
1.2.3.4
|
|
project
string
|
success |
Name of project the static NAT is related to.
Sample:
Production
|
|
vm_display_name
string
|
success |
Display name of the virtual machine.
Sample:
web-01
|
|
vm_guest_ip
string
|
success |
IP of the virtual machine.
Sample:
10.101.65.152
|
|
vm_name
string
|
success |
Name of the virtual machine.
Sample:
web-01
|
|
zone
string
|
success |
Name of zone the static NAT is related to.
Sample:
ch-gva-2
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.