delowan.googlecloud.gcp_compute_network (1.0.2) — module

Creates a GCP Network

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

Manages a VPC network or legacy network resource on GCP.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a network
  google.cloud.gcp_compute_network:
    name: test_object
    auto_create_subnetworks: 'true'
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Inputs

    
mtu:
    description:
    - Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and
      the maximum value is 1500 bytes.
    required: false
    type: int

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

description:
    description:
    - An optional description of this resource. The resource must be recreated to modify
      this field.
    required: false
    type: str

routing_config:
    description:
    - The network-level routing configuration for this network. Used by Cloud Router to
      determine what type of network-wide routing behavior to enforce.
    required: false
    suboptions:
      routing_mode:
        description:
        - The network-wide routing mode to use. If set to `REGIONAL`, this network's cloud
          routers will only advertise routes with subnetworks of this network in the same
          region as the router. If set to `GLOBAL`, this network's cloud routers will
          advertise routes with all subnetworks of this network, across regions.
        - 'Some valid choices include: "REGIONAL", "GLOBAL"'
        required: true
        type: str
    type: dict

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

auto_create_subnetworks:
    description:
    - When set to `true`, the network is created in "auto subnet mode" and it will create
      a subnet for each region automatically across the `10.128.0.0/9` address range.
    - When set to `false`, the network is created in "custom subnet mode" so the user
      can explicitly connect subnetwork resources.
    required: false
    type: bool

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

autoCreateSubnetworks:
  description:
  - When set to `true`, the network is created in "auto subnet mode" and it will create
    a subnet for each region automatically across the `10.128.0.0/9` address range.
  - When set to `false`, the network is created in "custom subnet mode" so the user
    can explicitly connect subnetwork resources.
  returned: success
  type: bool
creationTimestamp:
  description:
  - Creation timestamp in RFC3339 text format.
  returned: success
  type: str
description:
  description:
  - An optional description of this resource. The resource must be recreated to modify
    this field.
  returned: success
  type: str
gateway_ipv4:
  description:
  - The gateway address for default routing out of the network. This value is selected
    by GCP.
  returned: success
  type: str
id:
  description:
  - The unique identifier for the resource.
  returned: success
  type: int
mtu:
  description:
  - Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and
    the maximum value is 1500 bytes.
  returned: success
  type: int
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
routingConfig:
  contains:
    routingMode:
      description:
      - The network-wide routing mode to use. If set to `REGIONAL`, this network's
        cloud routers will only advertise routes with subnetworks of this network
        in the same region as the router. If set to `GLOBAL`, this network's cloud
        routers will advertise routes with all subnetworks of this network, across
        regions.
      returned: success
      type: str
  description:
  - The network-level routing configuration for this network. Used by Cloud Router
    to determine what type of network-wide routing behavior to enforce.
  returned: success
  type: complex
subnetworks:
  description:
  - Server-defined fully-qualified URLs for all subnetworks in this network.
  returned: success
  type: list