community.general.gce_eip (1.3.14) — module

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

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

Requirements

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

Usage examples

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

- name: Create a Regional external IP address
  community.general.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

Inputs

    
name:
    description:
    - Name of Address.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: The state the address should be in. C(present) or C(absent) are the only
      valid options.
    required: false
    type: str

region:
    description:
    - Region to create the address in. Set to 'global' to create a global address.
    required: true
    type: str

pem_file:
    description:
    - 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 I(credentials_file)
      instead.
    type: path

project_id:
    description:
    - The Google Cloud Platform project ID to use.
    type: str

credentials_file:
    description:
    - The path to the JSON file associated with the service account email.
    type: path

service_account_email:
    description:
    - service account email
    type: str

service_account_permissions:
    description:
    - service account permissions
    type: list

Outputs

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