Documentation

gce_eip - Create or Destroy Global or Regional External IP addresses.

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • python >= 2.6
  • apache-libcloud >= 0.19.0

Options

parameter required default choices comments
name
yes
Name of Address.
region
yes
Region to create the address in. Set to 'global' to create a global address.
state
no present
  • present
  • absent
The state the address should be in. present or absent are the only valid options.

Examples

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

# Create a Regional external IP address
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 Return Values, the following are the fields unique to this module:

name description returned type sample
region Which region an address belongs. always string global
name name of the address being operated on always string my-address
address IP address being operated on always string 35.186.222.233


Notes

Note

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.