community.general.gcp_compute_vpn_tunnel_facts (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Gather info for GCP VpnTunnel

Requirements

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: get info on a vpn tunnel
  gcp_compute_vpn_tunnel_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Inputs

    
region:
    description:
    - The region where the tunnel is located.
    required: true
    type: str

scopes:
    description:
    - Array of scopes to be used
    type: list

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

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

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

Outputs

resources:
  contains:
    creationTimestamp:
      description:
      - Creation timestamp in RFC3339 text format.
      returned: success
      type: str
    description:
      description:
      - An optional description of this resource.
      returned: success
      type: str
    id:
      description:
      - The unique identifier for the resource. This identifier is defined by the
        server.
      returned: success
      type: str
    ikeVersion:
      description:
      - IKE protocol version to use when establishing the VPN tunnel with peer VPN
        gateway.
      - Acceptable IKE versions are 1 or 2. Default version is 2.
      returned: success
      type: int
    localTrafficSelector:
      description:
      - Local traffic selector to use when establishing the VPN tunnel with peer VPN
        gateway. The value should be a CIDR formatted string, for example `192.168.0.0/16`.
        The ranges should be disjoint.
      - Only IPv4 is supported.
      returned: success
      type: list
    name:
      description:
      - Name of the resource. 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
    peerIp:
      description:
      - IP address of the peer VPN gateway. Only IPv4 is supported.
      returned: success
      type: str
    region:
      description:
      - The region where the tunnel is located.
      returned: success
      type: str
    remoteTrafficSelector:
      description:
      - Remote traffic selector to use when establishing the VPN tunnel with peer
        VPN gateway. The value should be a CIDR formatted string, for example `192.168.0.0/16`.
        The ranges should be disjoint.
      - Only IPv4 is supported.
      returned: success
      type: list
    router:
      description:
      - URL of router resource to be used for dynamic routing.
      returned: success
      type: dict
    sharedSecret:
      description:
      - Shared secret used to set the secure session between the Cloud VPN gateway
        and the peer VPN gateway.
      returned: success
      type: str
    sharedSecretHash:
      description:
      - Hash of the shared secret.
      returned: success
      type: str
    targetVpnGateway:
      description:
      - URL of the Target VPN gateway with which this VPN tunnel is associated.
      returned: success
      type: dict
  description: List of resources
  returned: always
  type: complex