delowan.googlecloud.gcp_compute_global_address (1.0.2) — module

Creates a GCP GlobalAddress

Authors: Google Inc. (@googlecloudplatform)

preview | supported by community

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 Global Address resource. Global addresses are used for HTTP(S) load balancing.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a global address
  google.cloud.gcp_compute_global_address:
    name: test_object
    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

address:
    description:
    - The static external IP address represented by this resource.
    required: false
    type: str

network:
    description:
    - The URL of the network in which to reserve the IP range. The IP range must be in
      RFC1918 space. The network cannot be deleted if there are any reserved IP ranges
      referring to it.
    - This should only be set when using an Internal address.
    - 'This field represents a link to a Network 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_network task and then set this network field to "{{ name-of-resource
      }}"'
    required: false
    type: dict

project:
    description:
    - The Google Cloud Platform project to use.
    type: str

purpose:
    description:
    - 'The purpose of the resource. Possible values include: * VPC_PEERING - for peer
      networks * PRIVATE_SERVICE_CONNECT - for ([Beta](U(https://terraform.io/docs/providers/google/guides/provider_versions.html))
      only) Private Service Connect networks .'
    required: false
    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

ip_version:
    description:
    - The IP Version that will be used by this address. The default value is `IPV4`.
    - 'Some valid choices include: "IPV4", "IPV6"'
    required: false
    type: str

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

address_type:
    default: EXTERNAL
    description:
    - The type of the address to reserve.
    - '* EXTERNAL indicates public/external single IP address.'
    - '* INTERNAL indicates internal IP ranges belonging to some network.'
    - 'Some valid choices include: "EXTERNAL", "INTERNAL"'
    required: false
    type: str

prefix_length:
    description:
    - The prefix length of the IP range. If not present, it means the address field is
      a single IP address.
    - This field is not applicable to addresses with addressType=EXTERNAL, or addressType=INTERNAL
      when purpose=PRIVATE_SERVICE_CONNECT .
    required: false
    type: int

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

address:
  description:
  - The static external IP address represented by this resource.
  returned: success
  type: str
addressType:
  description:
  - The type of the address to reserve.
  - '* EXTERNAL indicates public/external single IP address.'
  - '* INTERNAL indicates internal IP ranges belonging to some network.'
  returned: success
  type: str
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: int
ipVersion:
  description:
  - The IP Version that will be used by this address. The default value is `IPV4`.
  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
network:
  description:
  - The URL of the network in which to reserve the IP range. The IP range must be
    in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges
    referring to it.
  - This should only be set when using an Internal address.
  returned: success
  type: dict
prefixLength:
  description:
  - The prefix length of the IP range. If not present, it means the address field
    is a single IP address.
  - This field is not applicable to addresses with addressType=EXTERNAL, or addressType=INTERNAL
    when purpose=PRIVATE_SERVICE_CONNECT .
  returned: success
  type: int
purpose:
  description:
  - 'The purpose of the resource. Possible values include: * VPC_PEERING - for peer
    networks * PRIVATE_SERVICE_CONNECT - for ([Beta](U(https://terraform.io/docs/providers/google/guides/provider_versions.html))
    only) Private Service Connect networks .'
  returned: success
  type: str
region:
  description:
  - A reference to the region where the regional address resides.
  returned: success
  type: str