gcp_compute_interconnect_attachment_facts – Gather facts for GCP InterconnectAttachment

From Get docs
Ansible/docs/2.8/modules/gcp compute interconnect attachment facts module


gcp_compute_interconnect_attachment_facts – Gather facts for GCP InterconnectAttachment

New in version 2.8.


Synopsis

  • Gather facts for GCP InterconnectAttachment

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments

auth_kind

string / required

  • application
  • machineaccount
  • serviceaccount

The type of credential used.

filters

-

A list of filter value pairs. Available filters are listed here 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) .

project

string

The Google Cloud Platform project to use.

region

- / required

Region where the regional interconnect attachment resides.

scopes

list

Array of scopes to be used.

service_account_contents

string

A string representing the contents of a Service Account JSON file.

This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.



Notes

Note

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.


Examples

- name: " a interconnect attachment facts"
  gcp_compute_interconnect_attachment_facts:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: facts

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

items

complex

always

List of items


candidateSubnets

list

success

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.


cloudRouterIpAddress

string

success

IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.


creationTimestamp

string

success

Creation timestamp in RFC3339 text format.


customerRouterIpAddress

string

success

IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.


description

string

success

An optional description of this resource.


edgeAvailabilityDomain

string

success

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.


googleReferenceId

string

success

Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.


id

string

success

The unique identifier for the resource. This identifier is defined by the server.


interconnect

string

success

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.


name

string

success

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.


pairingKey

string

success

[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" .


partnerAsn

string

success

[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.


privateInterconnectInfo

complex

success

Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.


tag8021q

integer

success

802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.


region

string

success

Region where the regional interconnect attachment resides.


router

dictionary

success

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.


state

string

success

[Output Only] The current state of this attachment's functionality.


type

string

success

The type of InterconnectAttachment you wish to create. Defaults to DEDICATED.


vlanTag8021q

integer

success

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094.





Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_compute_interconnect_attachment_facts_module.html