mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-05-31 05:59:10 -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,55 +32,57 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: gcp_compute_interconnect_attachment
|
||||
description:
|
||||
- Represents an InterconnectAttachment (VLAN attachment) resource. For more information,
|
||||
see Creating VLAN Attachments.
|
||||
- Represents an InterconnectAttachment (VLAN attachment) resource. For more information,
|
||||
see Creating VLAN Attachments.
|
||||
short_description: Creates a 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:
|
||||
state:
|
||||
description:
|
||||
- Whether the given object should exist in GCP
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
interconnect:
|
||||
description:
|
||||
- URL of the underlying Interconnect object that this attachment's traffic will traverse
|
||||
through.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. .
|
||||
required: false
|
||||
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.
|
||||
- 'This field represents a link to a Router resource in GCP. It can be specified in
|
||||
two ways. You can add `register: name-of-resource` to a gcp_compute_router task
|
||||
and then set this router field to "{{ name-of-resource }}" Alternatively, you can
|
||||
set this router to a dictionary with the selfLink key where the value is the selfLink
|
||||
of your Router.'
|
||||
required: true
|
||||
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.
|
||||
required: true
|
||||
region:
|
||||
description:
|
||||
- Region where the regional interconnect attachment resides.
|
||||
required: true
|
||||
- Whether the given object should exist in GCP
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
default: present
|
||||
interconnect:
|
||||
description:
|
||||
- URL of the underlying Interconnect object that this attachment's traffic will
|
||||
traverse through.
|
||||
required: true
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. .
|
||||
required: false
|
||||
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.
|
||||
- 'This field represents a link to a Router resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_router
|
||||
task and then set this router field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this router to a dictionary with the selfLink key where the value
|
||||
is the selfLink of your Router'
|
||||
required: true
|
||||
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.
|
||||
required: true
|
||||
region:
|
||||
description:
|
||||
- Region where the regional interconnect attachment resides.
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
'''
|
||||
|
||||
|
|
@ -99,81 +101,81 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
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
|
||||
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