community.general.gcp_compute_subnetwork_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 Subnetwork

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 subnetwork
  gcp_compute_subnetwork_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 GCP region for this subnetwork.
    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. Provide this property when you create
        the resource. This field can be set only at resource creation time.
      returned: success
      type: str
    gatewayAddress:
      description:
      - The gateway address for default routes to reach destination addresses outside
        this subnetwork.
      returned: success
      type: str
    id:
      description:
      - The unique identifier for the resource.
      returned: success
      type: int
    ipCidrRange:
      description:
      - The range of internal addresses that are owned by this subnetwork.
      - Provide this property when you create the subnetwork. For example, 10.0.0.0/8
        or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
        Only IPv4 is supported.
      returned: success
      type: str
    name:
      description:
      - The name of the resource, provided by the client when initially creating 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
    network:
      description:
      - The network this subnet belongs to.
      - Only networks that are in the distributed mode can have subnetworks.
      returned: success
      type: dict
    privateIpGoogleAccess:
      description:
      - When enabled, VMs in this subnetwork without external IP addresses can access
        Google APIs and services by using Private Google Access.
      returned: success
      type: bool
    region:
      description:
      - URL of the GCP region for this subnetwork.
      returned: success
      type: str
    secondaryIpRanges:
      contains:
        ipCidrRange:
          description:
          - The range of IP addresses belonging to this subnetwork secondary range.
            Provide this property when you create the subnetwork.
          - Ranges must be unique and non-overlapping with all primary and secondary
            IP ranges within a network. Only IPv4 is supported.
          returned: success
          type: str
        rangeName:
          description:
          - The name associated with this subnetwork secondary range, used when adding
            an alias IP range to a VM instance. The name must be 1-63 characters long,
            and comply with RFC1035. The name must be unique within the subnetwork.
          returned: success
          type: str
      description:
      - An array of configurations for secondary IP ranges for VM instances contained
        in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange
        of the subnetwork. The alias IPs may belong to either primary or secondary
        ranges.
      returned: success
      type: complex
  description: List of resources
  returned: always
  type: complex