Documentation

gcp_compute_address – Creates a GCP Address

New in version 2.6.

Synopsis

  • Represents an Address resource.
  • Each virtual machine instance has an ephemeral internal IP address and, optionally, an external IP address. To communicate between instances on the same network, you can use an instance’s internal IP address. To communicate with the Internet and instances outside of the same network, you must specify the instance’s external IP address.
  • Internal IP addresses are ephemeral and only belong to an instance for the lifetime of the instance; if the instance is deleted and recreated, the instance is assigned a new internal IP address, either by Compute Engine or by you. External IP addresses can be either ephemeral or static.

Requirements

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

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
address
-
The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
address_type
-
added in 2.7
    Choices:
  • INTERNAL
  • EXTERNAL ←
The type of address to reserve, either INTERNAL or EXTERNAL.
If unspecified, defaults to EXTERNAL.
auth_kind
- / required
    Choices:
  • machineaccount
  • serviceaccount
  • application
The type of credential used.
description
-
An optional description of this resource.
name
- / required
Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project
-
Default:
None
The Google Cloud Platform project to use.
region
- / required
URL of the region where the regional address resides.
This field is not applicable to global addresses.
scopes
-
Array of scopes to be used.
service_account_email
-
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
-
The path of a Service Account JSON file if serviceaccount is selected as type.
state
-
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
subnetwork
-
added in 2.7
The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range.
This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.

Notes

Note

Examples

- name: create a address
  gcp_compute_address:
      name: test-address1
      region: us-west1
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

Return Values

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

Key Returned Description
address
string
success
The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.

address_type
string
success
The type of address to reserve, either INTERNAL or EXTERNAL.
If unspecified, defaults to EXTERNAL.

creation_timestamp
string
success
Creation timestamp in RFC3339 text format.

description
string
success
An optional description of this resource.

id
integer
success
The unique identifier for the resource.

name
string
success
Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region
string
success
URL of the region where the regional address resides.
This field is not applicable to global addresses.

subnetwork
dictionary
success
The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range.
This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.

users
list
success
The URLs of the resources that are using this address.



Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.