delowan.googlecloud.gcp_compute_external_vpn_gateway (1.0.2) — module

Install collection

Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2

Add to requirements.yml

  collections:
    - name: delowan.googlecloud
      version: 1.0.2

Description

Represents a VPN gateway managed outside of GCP.

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: create a external vpn gateway
  google.cloud.gcp_compute_external_vpn_gateway:
    name: test_object
    redundancy_type: SINGLE_IP_INTERNALLY_REDUNDANT
    descrpition: An externalyl managed VPN gateway
    interfaces:
    - id: 0
      ip_address: 8.8.8.8
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Inputs

    
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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the given object should exist in GCP
    type: str

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

interfaces:
    description:
    - A list of interfaces on this external VPN gateway.
    elements: dict
    required: false
    suboptions:
      id:
        description:
        - The numberic ID for this interface. Allowed values are based on the redundancy
          type of this external VPN gateway * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0,
          1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` .
        required: false
        type: int
      ip_address:
        description:
        - IP address of the interface in the external VPN gateway.
        - Only IPv4 is supported. This IP address can be either from your on-premise gateway
          or another Cloud provider's VPN gateway, it cannot be an IP address from Google
          Compute Engine.
        required: false
        type: str
    type: list

description:
    description:
    - An optional description of this resource.
    required: false
    type: str

redundancy_type:
    description:
    - Indicates the redundancy type of this external VPN gateway .
    - 'Some valid choices include: "FOUR_IPS_REDUNDANCY", "SINGLE_IP_INTERNALLY_REDUNDANT",
      "TWO_IPS_REDUNDANCY"'
    required: false
    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

description:
  description:
  - An optional description of this resource.
  returned: success
  type: str
interfaces:
  contains:
    id:
      description:
      - The numberic ID for this interface. Allowed values are based on the redundancy
        type of this external VPN gateway * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` *
        `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` .
      returned: success
      type: int
    ipAddress:
      description:
      - IP address of the interface in the external VPN gateway.
      - Only IPv4 is supported. This IP address can be either from your on-premise
        gateway or another Cloud provider's VPN gateway, it cannot be an IP address
        from Google Compute Engine.
      returned: success
      type: str
  description:
  - A list of interfaces on this external VPN gateway.
  returned: success
  type: complex
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
redundancyType:
  description:
  - Indicates the redundancy type of this external VPN gateway .
  returned: success
  type: str