Try SpotterCreates a GCP Address
Authors: Google Inc. (@googlecloudplatform)
preview | supported by community
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections:
- name: delowan.googlecloud
version: 1.0.2Represents 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.
- name: create a address
google.cloud.gcp_compute_address:
name: test-address1
region: us-west1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
name:
description:
- 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.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- Whether the given object should exist in GCP
type: str
region:
description:
- URL of the region where the regional address resides.
- This field is not applicable to global addresses.
required: true
type: str
scopes:
description:
- Array of scopes to be used
elements: str
type: list
address:
description:
- 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.
required: false
type: str
network:
description:
- The URL of the network in which to reserve the address. This field can only be used
with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.
- 'This field represents a link to a Network resource in GCP. It can be specified
in two ways. First, you can place a dictionary with key ''selfLink'' and value of
your resource''s selfLink Alternatively, you can add `register: name-of-resource`
to a gcp_compute_network task and then set this network field to "{{ name-of-resource
}}"'
required: false
type: dict
project:
description:
- The Google Cloud Platform project to use.
type: str
purpose:
description:
- 'The purpose of this resource, which can be one of the following values: * GCE_ENDPOINT
for addresses that are used by VM instances, alias IP ranges, internal load balancers,
and similar resources.'
- '* SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal
load balancers.'
- '* VPC_PEERING for addresses that are reserved for VPC peer networks.'
- '* IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved
for a VLAN attachment in an IPsec-encrypted Cloud Interconnect configuration. These
addresses are regional resources.'
- This should only be set when using an Internal address.
required: false
type: str
env_type:
description:
- Specifies which Ansible environment you're running this module within.
- This should not be set unless you know what you're doing.
- This only alters the User Agent string for any API requests.
type: str
auth_kind:
choices:
- application
- machineaccount
- serviceaccount
description:
- The type of credential used.
required: true
type: str
subnetwork:
description:
- 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.
- 'This field represents a link to a Subnetwork resource in GCP. It can be specified
in two ways. First, you can place a dictionary with key ''selfLink'' and value of
your resource''s selfLink Alternatively, you can add `register: name-of-resource`
to a gcp_compute_subnetwork task and then set this subnetwork field to "{{ name-of-resource
}}"'
required: false
type: dict
description:
description:
- An optional description of this resource.
required: false
type: str
address_type:
default: EXTERNAL
description:
- The type of address to reserve.
- 'Some valid choices include: "INTERNAL", "EXTERNAL"'
required: false
type: str
network_tier:
description:
- The networking tier used for configuring this address. If this field is not specified,
it is assumed to be PREMIUM.
- 'Some valid choices include: "PREMIUM", "STANDARD"'
required: false
type: str
prefix_length:
description:
- The prefix length if the resource represents an IP range.
required: false
type: int
service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path
service_account_email:
description:
- An optional service account email address if machineaccount is selected and the
user does not wish to use the default email.
type: str
service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a JSON
string that represents it.
type: jsonarg
address:
description:
- 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.
returned: success
type: str
addressType:
description:
- The type of address to reserve.
returned: success
type: str
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
description:
description:
- An optional description of this resource.
returned: success
type: str
id:
description:
- The unique identifier for the resource.
returned: success
type: int
name:
description:
- 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.
returned: success
type: str
network:
description:
- The URL of the network in which to reserve the address. This field can only be
used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.
returned: success
type: dict
networkTier:
description:
- The networking tier used for configuring this address. If this field is not specified,
it is assumed to be PREMIUM.
returned: success
type: str
prefixLength:
description:
- The prefix length if the resource represents an IP range.
returned: success
type: int
purpose:
description:
- 'The purpose of this resource, which can be one of the following values: * GCE_ENDPOINT
for addresses that are used by VM instances, alias IP ranges, internal load balancers,
and similar resources.'
- '* SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal
load balancers.'
- '* VPC_PEERING for addresses that are reserved for VPC peer networks.'
- '* IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved
for a VLAN attachment in an IPsec-encrypted Cloud Interconnect configuration.
These addresses are regional resources.'
- This should only be set when using an Internal address.
returned: success
type: str
region:
description:
- URL of the region where the regional address resides.
- This field is not applicable to global addresses.
returned: success
type: str
status:
description:
- The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
- An address that is RESERVING is currently in the process of being reserved.
- A RESERVED address is currently reserved and available to use. An IN_USE address
is currently being used by another resource and is not available.
returned: success
type: str
subnetwork:
description:
- 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.
returned: success
type: dict
users:
description:
- The URLs of the resources that are using this address.
returned: success
type: list