community.general.gcp_compute_route_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 Route

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 route
  gcp_compute_route_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Inputs

    
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:
    description:
      description:
      - An optional description of this resource. Provide this property when you create
        the resource.
      returned: success
      type: str
    destRange:
      description:
      - The destination range of outgoing packets that this route applies to.
      - Only IPv4 is supported.
      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 network that this route applies to.
      returned: success
      type: dict
    nextHopGateway:
      description:
      - URL to a gateway that should handle matching packets.
      - 'Currently, you can only specify the internet gateway, using a full or partial
        valid URL:'
      - ' * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway'
      - ' * projects/project/global/gateways/default-internet-gateway'
      - ' * global/gateways/default-internet-gateway'
      returned: success
      type: str
    nextHopIlb:
      description:
      - The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should
        handle matching packets.
      - 'You can only specify the forwarding rule as a partial or full URL. For example,
        the following are all valid URLs: U(https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule)
        regions/region/forwardingRules/forwardingRule Note that this can only be used
        when the destinationRange is a public (non-RFC 1918) IP CIDR range.'
      returned: success
      type: dict
    nextHopInstance:
      description:
      - URL to an instance that should handle matching packets.
      - 'You can specify this as a full or partial URL. For example:'
      - ' * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance'
      - ' * projects/project/zones/zone/instances/instance'
      - ' * zones/zone/instances/instance'
      returned: success
      type: dict
    nextHopIp:
      description:
      - Network IP address of an instance that should handle matching packets.
      returned: success
      type: str
    nextHopNetwork:
      description:
      - URL to a Network that should handle matching packets.
      returned: success
      type: str
    nextHopVpnTunnel:
      description:
      - URL to a VpnTunnel that should handle matching packets.
      returned: success
      type: dict
    priority:
      description:
      - The priority of this route. Priority is used to break ties in cases where
        there is more than one matching route of equal prefix length.
      - In the case of two routes with equal prefix length, the one with the lowest-numbered
        priority value wins.
      - Default value is 1000. Valid range is 0 through 65535.
      returned: success
      type: int
    tags:
      description:
      - A list of instance tags to which this route applies.
      returned: success
      type: list
  description: List of resources
  returned: always
  type: complex