Try SpotterCreates a GCP InterconnectAttachment
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 InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments.
- name: create a interconnect attachment
google.cloud.gcp_compute_interconnect_attachment:
name: test_object
region: us-central1
project: test_project
auth_kind: serviceaccount
interconnect: https://googleapis.com/compute/v1/projects/test_project/global/interconnects/...
router: https://googleapis.com/compute/v1/projects/test_project/regions/us-central1/routers/...
service_account_file: "/tmp/auth.pem"
state: present
register: disk
mtu:
description:
- Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect
attachment. Currently, only 1440 and 1500 are allowed. If not specified, the value
will default to 1440.
required: false
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.
required: true
type: str
type:
description:
- The type of InterconnectAttachment you wish to create. Defaults to DEDICATED.
- 'Some valid choices include: "DEDICATED", "PARTNER", "PARTNER_PROVIDER"'
required: false
type: str
state:
choices:
- present
- absent
default: present
description:
- Whether the given object should exist in GCP
type: str
region:
description:
- Region where the regional interconnect attachment resides.
required: true
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.
- 'This field represents a link to a Router 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_router task and then set this router field to "{{ name-of-resource
}}"'
required: true
type: dict
scopes:
description:
- Array of scopes to be used
elements: str
type: list
project:
description:
- The Google Cloud Platform project to use.
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
bandwidth:
description:
- Provisioned bandwidth capacity for the interconnect attachment.
- For attachments of type DEDICATED, the user can set the bandwidth.
- For attachments of type PARTNER, the Google Partner that is operating the interconnect
must set the bandwidth.
- Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, Defaults
to BPS_10G .
- 'Some valid choices include: "BPS_50M", "BPS_100M", "BPS_200M", "BPS_300M", "BPS_400M",
"BPS_500M", "BPS_1G", "BPS_2G", "BPS_5G", "BPS_10G", "BPS_20G", "BPS_50G"'
required: false
type: str
encryption:
default: NONE
description:
- 'Indicates the user-supplied encryption option of this interconnect attachment:
NONE is the default value, which means that the attachment carries unencrypted traffic.
VMs can send traffic to, or receive traffic from, this type of attachment.'
- IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device
such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic
from, such an attachment. To use IPsec-encrypted Cloud Interconnect create the attachment
using this option.
- Not currently available publicly.
- 'Some valid choices include: "NONE", "IPSEC"'
required: false
type: str
description:
description:
- An optional description of this resource.
required: false
type: str
interconnect:
description:
- URL of the underlying Interconnect object that this attachment's traffic will traverse
through. Required if type is DEDICATED, must not be set if type is PARTNER.
required: false
type: str
admin_enabled:
default: 'true'
description:
- Whether the VLAN attachment is enabled or disabled. When using PARTNER type this
will Pre-Activate the interconnect attachment .
required: false
type: bool
vlan_tag8021q:
description:
- The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. When using PARTNER
type this will be managed upstream.
required: false
type: int
candidate_subnets:
description:
- Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress
and customerRouterIpAddress for this attachment.
- All prefixes must be within link-local address space (169.254.0.0/16) and must be
/29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from
the supplied candidate prefix(es). The request will fail if all possible /29s are
in use on Google's edge. If not supplied, Google will randomly select an unused
/29 from all of link-local space.
elements: str
required: false
type: list
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
edge_availability_domain:
description:
- Desired availability domain for the attachment. Only available for type PARTNER,
at creation time. For improved reliability, customers should configure a pair of
attachments with one per availability domain. The selected availability domain will
be provided to the Partner via the pairing key so that the provisioned circuit will
lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
required: false
type: str
ipsec_internal_addresses:
description:
- URL of addresses that have been reserved for the interconnect attachment, Used only
for interconnect attachment that has the encryption option as IPSEC.
- The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over
the interconnect attachment, if the attachment is configured to use an RFC 1918
IP address, then the VPN gateway's IP address will be allocated from the IP address
range specified here.
- For example, if the HA VPN gateway's interface 0 is paired to this interconnect
attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be
allocated from the IP address specified for this interconnect attachment.
- If this field is not specified for interconnect attachment that has encryption option
as IPSEC, later on when creating HA VPN gateway on this interconnect attachment,
the HA VPN gateway's IP address will be allocated from regional external IP address
pool.
elements: dict
required: false
type: list
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
adminEnabled:
description:
- Whether the VLAN attachment is enabled or disabled. When using PARTNER type this
will Pre-Activate the interconnect attachment .
returned: success
type: bool
bandwidth:
description:
- Provisioned bandwidth capacity for the interconnect attachment.
- For attachments of type DEDICATED, the user can set the bandwidth.
- For attachments of type PARTNER, the Google Partner that is operating the interconnect
must set the bandwidth.
- Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, Defaults
to BPS_10G .
returned: success
type: str
candidateSubnets:
description:
- Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress
and customerRouterIpAddress for this attachment.
- All prefixes must be within link-local address space (169.254.0.0/16) and must
be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29
from the supplied candidate prefix(es). The request will fail if all possible
/29s are in use on Google's edge. If not supplied, Google will randomly select
an unused /29 from all of link-local space.
returned: success
type: list
cloudRouterIpAddress:
description:
- IPv4 address + prefix length to be configured on Cloud Router Interface for this
interconnect attachment.
returned: success
type: str
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
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
description:
description:
- An optional description of this resource.
returned: success
type: str
edgeAvailabilityDomain:
description:
- Desired availability domain for the attachment. Only available for type PARTNER,
at creation time. For improved reliability, customers should configure a pair
of attachments with one per availability domain. The selected availability domain
will be provided to the Partner via the pairing key so that the provisioned circuit
will lie in the specified domain. If not specified, the value will default to
AVAILABILITY_DOMAIN_ANY.
returned: success
type: str
encryption:
description:
- 'Indicates the user-supplied encryption option of this interconnect attachment:
NONE is the default value, which means that the attachment carries unencrypted
traffic. VMs can send traffic to, or receive traffic from, this type of attachment.'
- IPSEC indicates that the attachment carries only traffic encrypted by an IPsec
device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive
traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect create
the attachment using this option.
- Not currently available publicly.
returned: success
type: str
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
id:
description:
- The unique identifier for the resource. This identifier is defined by the server.
returned: success
type: str
interconnect:
description:
- URL of the underlying Interconnect object that this attachment's traffic will
traverse through. Required if type is DEDICATED, must not be set if type is PARTNER.
returned: success
type: str
ipsecInternalAddresses:
description:
- URL of addresses that have been reserved for the interconnect attachment, Used
only for interconnect attachment that has the encryption option as IPSEC.
- The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway
over the interconnect attachment, if the attachment is configured to use an RFC
1918 IP address, then the VPN gateway's IP address will be allocated from the
IP address range specified here.
- For example, if the HA VPN gateway's interface 0 is paired to this interconnect
attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be
allocated from the IP address specified for this interconnect attachment.
- If this field is not specified for interconnect attachment that has encryption
option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment,
the HA VPN gateway's IP address will be allocated from regional external IP address
pool.
returned: success
type: list
mtu:
description:
- Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect
attachment. Currently, only 1440 and 1500 are allowed. If not specified, the value
will default to 1440.
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
pairingKey:
description:
- '[Output only for type PARTNER. Not present for DEDICATED]. The opaque identifier
of an PARTNER attachment used to initiate provisioning with a selected partner.
Of the form "XXXXX/region/domain" .'
returned: success
type: str
partnerAsn:
description:
- '[Output only for type PARTNER. Not present for DEDICATED]. Optional BGP ASN for
the router that should be supplied by a layer 3 Partner if they configured BGP
on behalf of the customer.'
returned: success
type: str
privateInterconnectInfo:
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
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
region:
description:
- Region where the regional interconnect attachment resides.
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
state:
description:
- '[Output Only] The current state of this attachment''s functionality.'
returned: success
type: str
type:
description:
- The type of InterconnectAttachment you wish to create. Defaults to DEDICATED.
returned: success
type: str
vlanTag8021q:
description:
- The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. When using
PARTNER type this will be managed upstream.
returned: success
type: int