You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.google.gce_eip module – Create or Destroy Global or Regional External IP addresses.

Note

This module is part of the community.google collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.google.

To use it in a playbook, specify: community.google.gce_eip.

Synopsis

• Create (reserve) or Destroy (release) Regional or Global IP Addresses. See https://cloud.google.com/compute/docs/configure-instance-ip-addresses#reserve_new_static for more on reserving static addresses.

Requirements

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

• python >= 2.6

• apache-libcloud >= 0.19.0

Parameters

Parameter	Comments
credentials_file path	The path to the JSON file associated with the service account email.
name string / required	Name of Address.
pem_file path	The path to the PEM file associated with the service account email. This option is deprecated and may be removed in a future release. Use credentials_file instead.
project_id string	The Google Cloud Platform project ID to use.
region string / required	Region to create the address in. Set to ‘global’ to create a global address.
service_account_email string	service account email
service_account_permissions list / elements=string	service account permissions
state string	The state the address should be in. present or absent are the only valid options. Choices: present ← (default) absent

Notes

Note

• Global addresses can only be used with Global Forwarding Rules.

Examples

- name: Create a Global external IP address
  community.google.gce_eip:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    name: my-global-ip
    region: global
    state: present

- name: Create a Regional external IP address
  community.google.gce_eip:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    name: my-global-ip
    region: us-east1
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
address string	IP address being operated on Returned: always Sample: “35.186.222.233”
name string	name of the address being operated on Returned: always Sample: “my-address”
region string	Which region an address belongs. Returned: always Sample: “global”

Authors

• Tom Melendez (@supertom)

Collection links

Issue Tracker Repository (Sources)