NAT Gateway

nat_gateway

This is a simple module that supports creating or removing NATGateways. This module has a dependency on ionoscloud >= 6.0.2

Example Syntax

name: Create NAT Gateway
ionoscloudsdk.ionoscloud.nat_gateway:
  datacenter: ''
  name: 'AnsibleAutoTestNAT'
  public_ips: ''
  lans:
  - id: ''
    gateway_ips:
    - 10.11.2.5/24
  wait_timeout: 2000
  wait: true
register: nat_gateway_response


name: Update NAT Gateway
ionoscloudsdk.ionoscloud.nat_gateway:
  datacenter: ''
  name: 'AnsibleAutoTestNAT - UPDATED'
  public_ips: ''
  nat_gateway: ''
  wait_timeout: 2000
  wait: true
  state: update
register: nat_gateway_response_update


name: Remove NAT Gateway
ionoscloudsdk.ionoscloud.nat_gateway:
  nat_gateway: ''
  datacenter: ''
  wait: false
  wait_timeout: 2000
  state: absent

Returned object

{
    "changed": false,
    "failed": false,
    "action": "create",
    "nat_gateway": {
        "entities": {
            "flowlogs": {
                "links": null,
                "href": "https://api.ionos.com/cloudapi/v6/datacenters/0406692b-b25f-4a58-8b41-e3b2d761447c/natgateways/abcc8593-a4a9-4ea0-b63c-04f95f395aa0/flowlogs",
                "id": "abcc8593-a4a9-4ea0-b63c-04f95f395aa0/flowlogs",
                "items": null,
                "limit": null,
                "offset": null,
                "type": "collection"
            },
            "rules": {
                "href": "https://api.ionos.com/cloudapi/v6/datacenters/0406692b-b25f-4a58-8b41-e3b2d761447c/natgateways/abcc8593-a4a9-4ea0-b63c-04f95f395aa0/rules",
                "id": "abcc8593-a4a9-4ea0-b63c-04f95f395aa0/rules",
                "items": null,
                "type": "collection"
            }
        },
        "href": "https://api.ionos.com/cloudapi/v6/datacenters/0406692b-b25f-4a58-8b41-e3b2d761447c/natgateways/abcc8593-a4a9-4ea0-b63c-04f95f395aa0",
        "id": "abcc8593-a4a9-4ea0-b63c-04f95f395aa0",
        "metadata": {
            "created_by": "<USER_EMAIL>",
            "created_by_user_id": "<USER_ID>",
            "created_date": "2023-05-31T11:46:08+00:00",
            "etag": "f64f5fbd951032447f9e9a9b0d7ab1a2",
            "last_modified_by": "<USER_EMAIL>",
            "last_modified_by_user_id": "<USER_ID>",
            "last_modified_date": "2023-05-31T11:46:08+00:00",
            "state": "AVAILABLE"
        },
        "properties": {
            "lans": [],
            "name": "AnsibleAutoTestNAT",
            "public_ips": [
                "<IP1>",
                "<IP2>"
            ]
        },
        "type": "natgateway"
    }
}

For more examples please check out the tests here.

state: present

  
name: Create NAT Gateway
ionoscloudsdk.ionoscloud.nat_gateway:
  datacenter: ''
  name: 'AnsibleAutoTestNAT'
  public_ips: ''
  lans:
  - id: ''
    gateway_ips:
    - 10.11.2.5/24
  wait_timeout: 2000
  wait: true
register: nat_gateway_response

Available parameters for state present:

Name	Required	Description
name str	True	Name of the NAT Gateway.
public_ips list	True	Collection of public IP addresses of the NAT Gateway. Should be customer reserved IP addresses in that location.
lans list	False	Collection of LANs connected to the NAT Gateway. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.
datacenter str	True	The ID or name of the datacenter.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: absent

  
name: Remove NAT Gateway
ionoscloudsdk.ionoscloud.nat_gateway:
  nat_gateway: ''
  datacenter: ''
  wait: false
  wait_timeout: 2000
  state: absent

Available parameters for state absent:

Name	Required	Description
name str	False	Name of the NAT Gateway.
datacenter str	True	The ID or name of the datacenter.
nat_gateway str	True	The ID or name of the NAT Gateway.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: update

  
name: Update NAT Gateway
ionoscloudsdk.ionoscloud.nat_gateway:
  datacenter: ''
  name: 'AnsibleAutoTestNAT - UPDATED'
  public_ips: ''
  nat_gateway: ''
  wait_timeout: 2000
  wait: true
  state: update
register: nat_gateway_response_update

Available parameters for state update:

Name	Required	Description
name str	False	Name of the NAT Gateway.
public_ips list	False	Collection of public IP addresses of the NAT Gateway. Should be customer reserved IP addresses in that location.
lans list	False	Collection of LANs connected to the NAT Gateway. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.
datacenter str	True	The ID or name of the datacenter.
nat_gateway str	True	The ID or name of the NAT Gateway.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']