removing documentation fragment

Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
Alex Stephen 2019-09-06 20:12:02 +00:00 committed by Modular Magician
commit 84e760b022
130 changed files with 6177 additions and 370 deletions

View file

@ -42,7 +42,7 @@ description:
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
version_added: '2.6'
author: Google Inc. (@googlecloudplatform)
requirements:
- python >= 2.6
@ -72,7 +72,7 @@ options:
required: false
default: EXTERNAL
type: str
version_added: 2.7
version_added: '2.7'
description:
description:
- An optional description of this resource.
@ -87,6 +87,16 @@ options:
letter, or digit, except the last character, which cannot be a dash.
required: true
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.'
- This should only be set when using an Internal address.
- 'Some valid choices include: "GCE_ENDPOINT"'
required: false
type: str
version_added: '2.10'
network_tier:
description:
- 'The networking tier used for configuring this address. This field can take
@ -95,7 +105,7 @@ options:
- 'Some valid choices include: "PREMIUM", "STANDARD"'
required: false
type: str
version_added: 2.8
version_added: '2.8'
subnetwork:
description:
- The URL of the subnetwork in which to reserve the address. If an IP address
@ -109,18 +119,64 @@ options:
}}"'
required: false
type: dict
version_added: 2.7
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
type: str
extends_documentation_fragment: gcp
project:
description:
- The Google Cloud Platform project to use.
type: str
auth_kind:
description:
- The type of credential used.
type: str
required: true
choices:
- application
- machineaccount
- serviceaccount
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
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
scopes:
description:
- Array of scopes to be used
type: list
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
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)'
- for authentication, you can set service_account_file using the c(gcp_service_account_file)
env variable.
- for authentication, you can set service_account_contents using the c(GCP_SERVICE_ACCOUNT_CONTENTS)
env variable.
- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL)
env variable.
- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
- Environment variables values will only be used if the playbook values are not set.
- The I(service_account_email) and I(service_account_file) options are mutually exclusive.
'''
EXAMPLES = '''
@ -172,6 +228,14 @@ name:
except the last character, which cannot be a dash.
returned: success
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.'
- This should only be set when using an Internal address.
returned: success
type: str
networkTier:
description:
- 'The networking tier used for configuring this address. This field can take the
@ -223,6 +287,7 @@ def main():
address_type=dict(default='EXTERNAL', type='str'),
description=dict(type='str'),
name=dict(required=True, type='str'),
purpose=dict(type='str'),
network_tier=dict(type='str'),
subnetwork=dict(type='dict'),
region=dict(required=True, type='str'),
@ -282,6 +347,7 @@ def resource_to_request(module):
u'addressType': module.params.get('address_type'),
u'description': module.params.get('description'),
u'name': module.params.get('name'),
u'purpose': module.params.get('purpose'),
u'networkTier': module.params.get('network_tier'),
u'subnetwork': replace_resource_dict(module.params.get(u'subnetwork', {}), 'selfLink'),
}
@ -355,6 +421,7 @@ def response_to_hash(module, response):
u'description': response.get(u'description'),
u'id': response.get(u'id'),
u'name': response.get(u'name'),
u'purpose': response.get(u'purpose'),
u'networkTier': response.get(u'networkTier'),
u'subnetwork': response.get(u'subnetwork'),
u'users': response.get(u'users'),