On this page
gce_eip - Create or Destroy Global or Regional External IP addresses.
New in version 2.3.
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 (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 |
|
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 |
---|---|---|---|---|
address |
IP address being operated on
|
always | string | 35.186.222.233 |
name |
name of the address being operated on
|
always | string | my-address |
region |
Which region an address belongs.
|
always | string | global |
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.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/gce_eip_module.html