community.general.gcp_compute_address_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 Address

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 an address
  gcp_compute_address_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Inputs

    
region:
    description:
    - URL of the region where the regional address resides.
    - This field is not applicable to global addresses.
    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:
    address:
      description:
      - The static external IP address represented by this resource. Only IPv4 is
        supported. An address may only be specified for INTERNAL address types. The
        IP address must be inside the specified subnetwork, if any.
      returned: success
      type: str
    addressType:
      description:
      - The type of address to reserve, either INTERNAL or EXTERNAL.
      - If unspecified, defaults to EXTERNAL.
      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.
      returned: success
      type: int
    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
    networkTier:
      description:
      - 'The networking tier used for configuring this address. This field can take
        the following values: PREMIUM or STANDARD. If this field is not specified,
        it is assumed to be PREMIUM.'
      returned: success
      type: str
    purpose:
      description:
      - 'The purpose of this resource, which can be one of the following values: -
        GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges,
        internal load balancers, and similar resources.'
      - This should only be set when using an Internal address.
      returned: success
      type: str
    region:
      description:
      - URL of the region where the regional address resides.
      - This field is not applicable to global addresses.
      returned: success
      type: str
    subnetwork:
      description:
      - The URL of the subnetwork in which to reserve the address. If an IP address
        is specified, it must be within the subnetwork's IP range.
      - This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER
        purposes.
      returned: success
      type: dict
    users:
      description:
      - The URLs of the resources that are using this address.
      returned: success
      type: list
  description: List of resources
  returned: always
  type: complex