mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-27 23:21:31 -07:00
Alex Stephen
parent
5c97cc1da0
commit
d64785e811
80 changed files with 14198 additions and 13862 deletions
|
|
@ -32,85 +32,92 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: gcp_compute_address
|
||||
description:
|
||||
- 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.
|
||||
- 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.
|
||||
short_description: Creates a GCP Address
|
||||
version_added: 2.6
|
||||
author: Google Inc. (@googlecloudplatform)
|
||||
requirements:
|
||||
- python >= 2.6
|
||||
- requests >= 2.18.4
|
||||
- google-auth >= 1.3.0
|
||||
- python >= 2.6
|
||||
- requests >= 2.18.4
|
||||
- google-auth >= 1.3.0
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Whether the given object should exist in GCP
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
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
|
||||
address_type:
|
||||
description:
|
||||
- The type of address to reserve, either INTERNAL or EXTERNAL.
|
||||
- If unspecified, defaults to EXTERNAL.
|
||||
required: false
|
||||
default: EXTERNAL
|
||||
version_added: 2.7
|
||||
choices: ['INTERNAL', 'EXTERNAL']
|
||||
state:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
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
|
||||
network_tier:
|
||||
description:
|
||||
- 'The networking tier used for configuring this address. This field can take the
|
||||
following values: PREMIUM or STANDARD. If this field is not specified, it is assumed
|
||||
to be PREMIUM.'
|
||||
required: false
|
||||
version_added: 2.8
|
||||
choices: ['PREMIUM', 'STANDARD']
|
||||
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. You can add `register: name-of-resource` to a gcp_compute_subnetwork
|
||||
task and then set this subnetwork field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this subnetwork to a dictionary with the selfLink key where the value
|
||||
is the selfLink of your Subnetwork.'
|
||||
required: false
|
||||
version_added: 2.7
|
||||
region:
|
||||
description:
|
||||
- URL of the region where the regional address resides.
|
||||
- This field is not applicable to global addresses.
|
||||
required: true
|
||||
- Whether the given object should exist in GCP
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
default: present
|
||||
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
|
||||
address_type:
|
||||
description:
|
||||
- The type of address to reserve, either INTERNAL or EXTERNAL.
|
||||
- If unspecified, defaults to EXTERNAL.
|
||||
required: false
|
||||
default: EXTERNAL
|
||||
version_added: 2.7
|
||||
choices:
|
||||
- INTERNAL
|
||||
- EXTERNAL
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
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
|
||||
network_tier:
|
||||
description:
|
||||
- 'The networking tier used for configuring this address. This field can take
|
||||
the following values: PREMIUM or STANDARD. If this field is not specified, it
|
||||
is assumed to be PREMIUM.'
|
||||
required: false
|
||||
version_added: 2.8
|
||||
choices:
|
||||
- PREMIUM
|
||||
- STANDARD
|
||||
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. You can add `register: name-of-resource` to a gcp_compute_subnetwork
|
||||
task and then set this subnetwork field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this subnetwork to a dictionary with the selfLink key where the
|
||||
value is the selfLink of your Subnetwork'
|
||||
required: false
|
||||
version_added: 2.7
|
||||
region:
|
||||
description:
|
||||
- URL of the region where the regional address resides.
|
||||
- This field is not applicable to global addresses.
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
notes:
|
||||
- "API Reference: U(https://cloud.google.com/compute/docs/reference/beta/addresses)"
|
||||
- "Reserving a Static External IP Address: U(https://cloud.google.com/compute/docs/instances-and-network)"
|
||||
- "Reserving a Static Internal IP Address: U(https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address)"
|
||||
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/beta/addresses)'
|
||||
- 'Reserving a Static External IP Address: U(https://cloud.google.com/compute/docs/instances-and-network)'
|
||||
- 'Reserving a Static Internal IP Address: U(https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address)'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
@ -125,68 +132,69 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
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, either INTERNAL or EXTERNAL.
|
||||
- If unspecified, defaults to EXTERNAL.
|
||||
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
|
||||
networkTier:
|
||||
description:
|
||||
- 'The networking tier used for configuring this address. This field can take the
|
||||
following values: PREMIUM or STANDARD. If this field is not specified, it is assumed
|
||||
to be PREMIUM.'
|
||||
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
|
||||
region:
|
||||
description:
|
||||
- URL of the region where the regional address resides.
|
||||
- This field is not applicable to global addresses.
|
||||
returned: success
|
||||
type: str
|
||||
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, either INTERNAL or EXTERNAL.
|
||||
- If unspecified, defaults to EXTERNAL.
|
||||
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
|
||||
networkTier:
|
||||
description:
|
||||
- 'The networking tier used for configuring this address. This field can take the
|
||||
following values: PREMIUM or STANDARD. If this field is not specified, it is assumed
|
||||
to be PREMIUM.'
|
||||
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
|
||||
region:
|
||||
description:
|
||||
- URL of the region where the regional address resides.
|
||||
- This field is not applicable to global addresses.
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
@ -373,8 +381,6 @@ def wait_for_completion(status, op_result, module):
|
|||
while status != 'DONE':
|
||||
raise_if_errors(op_result, ['error', 'errors'], 'message')
|
||||
time.sleep(1.0)
|
||||
if status not in ['PENDING', 'RUNNING', 'DONE']:
|
||||
module.fail_json(msg="Invalid result %s" % status)
|
||||
op_result = fetch_resource(module, op_uri, 'compute#operation')
|
||||
status = navigate_hash(op_result, ['status'])
|
||||
return op_result
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue