mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-26 14:41:29 -07:00
Documentation Refactor
This commit is contained in:
The Magician
Alex Stephen
parent
6a98471a53
commit
87656c4016
88 changed files with 11960 additions and 12598 deletions
|
|
@ -32,25 +32,24 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: gcp_compute_interconnect_attachment_facts
|
||||
description:
|
||||
- Gather facts for GCP InterconnectAttachment
|
||||
- Gather facts for GCP InterconnectAttachment
|
||||
short_description: Gather facts for GCP InterconnectAttachment
|
||||
version_added: 2.8
|
||||
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:
|
||||
filters:
|
||||
description:
|
||||
A list of filter value pairs. Available filters are listed here
|
||||
U(https://cloud.google.com/sdk/gcloud/reference/topic/filters).
|
||||
Each additional filter in the list will act be added as an AND condition
|
||||
(filter1 and filter2)
|
||||
region:
|
||||
description:
|
||||
- Region where the regional interconnect attachment resides.
|
||||
required: true
|
||||
filters:
|
||||
description:
|
||||
- A list of filter value pairs. Available filters are listed here U(U(https://cloud.google.com/sdk/gcloud/reference/topic/filters).)
|
||||
- Each additional filter in the list will act be added as an AND condition (filter1
|
||||
and filter2) .
|
||||
region:
|
||||
description:
|
||||
- Region where the regional interconnect attachment resides.
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
'''
|
||||
|
||||
|
|
@ -67,85 +66,86 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
items:
|
||||
description: List of items
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
cloudRouterIpAddress:
|
||||
description:
|
||||
- IPv4 address + prefix length to be configured on Cloud Router Interface for this
|
||||
interconnect attachment.
|
||||
returned: success
|
||||
type: str
|
||||
customerRouterIpAddress:
|
||||
description:
|
||||
- IPv4 address + prefix length to be configured on the customer router subinterface
|
||||
for this interconnect attachment.
|
||||
returned: success
|
||||
type: str
|
||||
interconnect:
|
||||
description:
|
||||
- URL of the underlying Interconnect object that this attachment's traffic will traverse
|
||||
through.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. .
|
||||
returned: success
|
||||
type: str
|
||||
privateInterconnectInfo:
|
||||
description:
|
||||
- Information specific to an InterconnectAttachment. This property is populated if
|
||||
the interconnect that this is attached to is of type DEDICATED.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
tag8021q:
|
||||
description:
|
||||
- 802.1q encapsulation tag to be used for traffic between Google and the customer,
|
||||
going to and from this network and region.
|
||||
returned: success
|
||||
type: int
|
||||
googleReferenceId:
|
||||
description:
|
||||
- Google reference ID, to be used when raising support tickets with Google or otherwise
|
||||
to debug backend connectivity issues.
|
||||
returned: success
|
||||
type: str
|
||||
router:
|
||||
description:
|
||||
- URL of the cloud router to be used for dynamic routing. This router must be in the
|
||||
same region as this InterconnectAttachment. The InterconnectAttachment will automatically
|
||||
connect the Interconnect to the network & region within which the Cloud Router is
|
||||
configured.
|
||||
returned: success
|
||||
type: dict
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource. This identifier is defined by the server.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. 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
|
||||
region:
|
||||
description:
|
||||
- Region where the regional interconnect attachment resides.
|
||||
returned: success
|
||||
type: str
|
||||
description: List of items
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
cloudRouterIpAddress:
|
||||
description:
|
||||
- IPv4 address + prefix length to be configured on Cloud Router Interface for
|
||||
this interconnect attachment.
|
||||
returned: success
|
||||
type: str
|
||||
customerRouterIpAddress:
|
||||
description:
|
||||
- IPv4 address + prefix length to be configured on the customer router subinterface
|
||||
for this interconnect attachment.
|
||||
returned: success
|
||||
type: str
|
||||
interconnect:
|
||||
description:
|
||||
- URL of the underlying Interconnect object that this attachment's traffic will
|
||||
traverse through.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. .
|
||||
returned: success
|
||||
type: str
|
||||
privateInterconnectInfo:
|
||||
description:
|
||||
- Information specific to an InterconnectAttachment. This property is populated
|
||||
if the interconnect that this is attached to is of type DEDICATED.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
tag8021q:
|
||||
description:
|
||||
- 802.1q encapsulation tag to be used for traffic between Google and the
|
||||
customer, going to and from this network and region.
|
||||
returned: success
|
||||
type: int
|
||||
googleReferenceId:
|
||||
description:
|
||||
- Google reference ID, to be used when raising support tickets with Google or
|
||||
otherwise to debug backend connectivity issues.
|
||||
returned: success
|
||||
type: str
|
||||
router:
|
||||
description:
|
||||
- URL of the cloud router to be used for dynamic routing. This router must be
|
||||
in the same region as this InterconnectAttachment. The InterconnectAttachment
|
||||
will automatically connect the Interconnect to the network & region within
|
||||
which the Cloud Router is configured.
|
||||
returned: success
|
||||
type: dict
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource. This identifier is defined by the
|
||||
server.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created.
|
||||
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
|
||||
region:
|
||||
description:
|
||||
- Region where the regional interconnect attachment resides.
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue