ngine_io.cloudstack.cs_staticnat – Manages static NATs on Apache CloudStack based clouds.

From Get docs
Ansible/docs/2.11/collections/ngine io/cloudstack/cs staticnat module


ngine_io.cloudstack.cs_staticnat – Manages static NATs on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.0.0).

To install it use: ansible-galaxy collection install ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_staticnat.


New in version 0.1.0: of ngine_io.cloudstack


Synopsis

  • Create, update and remove static NATs.

Requirements

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

  • python >= 2.6
  • cs >= 0.9.0

Parameters

Parameter Choices/Defaults Comments

account

string

Account the static NAT is related to.

api_http_method

string

  • get

  • post

HTTP method used to query the API endpoint.

If not given, the CLOUDSTACK_METHOD env variable is considered.

api_key

string / required

API key of the CloudStack API.

If not given, the CLOUDSTACK_KEY env variable is considered.

api_secret

string / required

Secret key of the CloudStack API.

If not set, the CLOUDSTACK_SECRET env variable is considered.

api_timeout

integer

Default:

10

HTTP timeout in seconds.

If not given, the CLOUDSTACK_TIMEOUT env variable is considered.

api_url

string / required

URL of the CloudStack API e.g. https://cloud.example.com/client/api.

If not given, the CLOUDSTACK_ENDPOINT env variable is considered.

api_verify_ssl_cert

string

Verify CA authority cert file.

If not given, the CLOUDSTACK_VERIFY env variable is considered.

domain

string

Domain the static NAT is related to.

ip_address

string / required

Public IP address the static NAT is assigned to.

network

string

Network the IP address is related to.

poll_async

boolean

  • no
  • yes

Poll async jobs until job has finished.

project

string

Name of the project the static NAT is related to.

state

string

  • present

  • absent

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

VPC the network related to.

zone

string / required

Name of the zone in which the virtual machine is in.



Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.


Examples

- name: Create a static NAT for IP 1.2.3.4 to web01
  ngine_io.cloudstack.cs_staticnat:
    ip_address: 1.2.3.4
    zone: zone01
    vm: web01

- name: Remove a static NAT
  ngine_io.cloudstack.cs_staticnat:
    ip_address: 1.2.3.4
    zone: zone01
    state: absent

Return Values

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




Authors

  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_staticnat_module.html