ansible.builtin.cs_staticnat (v2.9.18) — module

Install Ansible via pip

Install with pip install ansible==2.9.18

Description

Create, update and remove static NATs.

Requirements

• python >= 2.6
• cs >= 0.9.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove a static NAT
  cs_staticnat:
    ip_address: 1.2.3.4
    state: absent
  delegate_to: localhost

Inputs

    
vm:
    description:
    - Name of virtual machine which we make the static NAT for.
    - Required if I(state=present).
    type: str

vpc:
    description:
    - VPC the network related to.
    type: str
    version_added: '2.3'
    version_added_collection: ansible.builtin

zone:
    description:
    - Name of the zone in which the virtual machine is in.
    - If not set, default zone is used.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the static NAT.
    type: str

domain:
    description:
    - Domain the static NAT is related to.
    type: str

account:
    description:
    - Account the static NAT is related to.
    type: str

api_key:
    description:
    - API key of the CloudStack API.
    - If not given, the C(CLOUDSTACK_KEY) env variable is considered.
    required: true
    type: str

api_url:
    description:
    - URL of the CloudStack API e.g. https://cloud.example.com/client/api.
    - If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered.
    required: true
    type: str

network:
    description:
    - Network the IP address is related to.
    type: str
    version_added: '2.2'
    version_added_collection: ansible.builtin

project:
    description:
    - Name of the project the static NAT is related to.
    type: str

api_secret:
    description:
    - Secret key of the CloudStack API.
    - If not set, the C(CLOUDSTACK_SECRET) env variable is considered.
    required: true
    type: str

ip_address:
    description:
    - Public IP address the static NAT is assigned to.
    required: true
    type: str

poll_async:
    default: true
    description:
    - Poll async jobs until job has finished.
    type: bool

api_timeout:
    default: 10
    description:
    - HTTP timeout in seconds.
    - If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered.
    type: int

vm_guest_ip:
    description:
    - VM guest NIC secondary IP address for the static NAT.
    type: str

api_http_method:
    choices:
    - get
    - post
    default: get
    description:
    - HTTP method used to query the API endpoint.
    - If not given, the C(CLOUDSTACK_METHOD) env variable is considered.
    type: str

api_verify_ssl_cert:
    description:
    - Verify CA authority cert file.
    - If not given, the C(CLOUDSTACK_VERIFY) env variable is considered.
    type: str

Outputs

account:
  description: Account the static NAT is related to.
  returned: success
  sample: example account
  type: str
domain:
  description: Domain the static NAT is related to.
  returned: success
  sample: example domain
  type: str
id:
  description: UUID of the ip_address.
  returned: success
  sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
  type: str
ip_address:
  description: Public IP address.
  returned: success
  sample: 1.2.3.4
  type: str
project:
  description: Name of project the static NAT is related to.
  returned: success
  sample: Production
  type: str
vm_display_name:
  description: Display name of the virtual machine.
  returned: success
  sample: web-01
  type: str
vm_guest_ip:
  description: IP of the virtual machine.
  returned: success
  sample: 10.101.65.152
  type: str
vm_name:
  description: Name of the virtual machine.
  returned: success
  sample: web-01
  type: str
zone:
  description: Name of zone the static NAT is related to.
  returned: success
  sample: ch-gva-2
  type: str