Class: Ansible::Ruby::Modules::Gce_net

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Gce_net

Defined in:

lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb

Overview

This module can create and destroy Google Compute Engine networks and firewall rules U(cloud.google.com/compute/docs/networking). The I(name) parameter is reserved for referencing a network while the I(fwname) parameter is used to reference firewall rules. IPv4 Address ranges must be specified using the CIDR U(en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) format. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Instance Method Summary

• #allowed ⇒ String^?

  The protocol:ports to allow (I(tcp:80) or I(tcp:80,443) or I(tcp:80-800;udp:1-25)) this parameter is mandatory when creating or updating a firewall rule.

• #credentials_file ⇒ Object^?

  Path to the JSON file associated with the service account email.

• #fwname ⇒ String^?

  Name of the firewall rule.

• #ipv4_range ⇒ String^?

  The IPv4 address range in CIDR notation for the network this parameter is not mandatory when you specified existing network in name parameter, but when you create new network, this parameter is mandatory.

• #mode ⇒ :legacy, ...

  Network mode for Google Cloud C(legacy) indicates a network with an IP address range; C(auto) automatically generates subnetworks in different regions; C(custom) uses networks to group subnets of user specified IP address ranges cloud.google.com/compute/docs/networking#network_types.

• #name ⇒ String^?

  Name of the network.

• #pem_file ⇒ Object^?

  Path to the pem file associated with the service account email This option is deprecated.

• #project_id ⇒ Object^?

  Your GCE project ID.

• #service_account_email ⇒ Object^?

  Service account email.

• #src_range ⇒ Object^?

  The source IPv4 address range in CIDR notation.

• #src_tags ⇒ Object^?

  The source instance tags for creating a firewall rule.

• #state ⇒ :active, ...

  Desired state of the network or firewall.

• #subnet_desc ⇒ Object^?

  Description of subnet to create.

• #subnet_name ⇒ String^?

  Name of subnet to create.

• #subnet_region ⇒ String^?

  Region of subnet to create.

• #target_tags ⇒ Object^?

  The target instance tags for creating a firewall rule.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#allowed ⇒ String^?

Returns the protocol:ports to allow (I(tcp:80) or I(tcp:80,443) or I(tcp:80-800;udp:1-25)) this parameter is mandatory when creating or updating a firewall rule.

Returns:

• (String, nil) —

  the protocol:ports to allow (I(tcp:80) or I(tcp:80,443) or I(tcp:80-800;udp:1-25)) this parameter is mandatory when creating or updating a firewall rule

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 12

attribute :allowed

#credentials_file ⇒ Object^?

Returns path to the JSON file associated with the service account email.

Returns:

• (Object, nil) —

  path to the JSON file associated with the service account email

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 47

attribute :credentials_file

#fwname ⇒ String^?

Returns name of the firewall rule.

Returns:

• (String, nil) —

  name of the firewall rule

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 20

attribute :fwname

#ipv4_range ⇒ String^?

Returns the IPv4 address range in CIDR notation for the network this parameter is not mandatory when you specified existing network in name parameter, but when you create new network, this parameter is mandatory.

Returns:

• (String, nil) —

  the IPv4 address range in CIDR notation for the network this parameter is not mandatory when you specified existing network in name parameter, but when you create new network, this parameter is mandatory

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 16

attribute :ipv4_range

#mode ⇒ :legacy, ...

Returns network mode for Google Cloud C(legacy) indicates a network with an IP address range; C(auto) automatically generates subnetworks in different regions; C(custom) uses networks to group subnets of user specified IP address ranges cloud.google.com/compute/docs/networking#network_types.

Returns:

• (:legacy, :auto, :custom, nil) —

  network mode for Google Cloud C(legacy) indicates a network with an IP address range; C(auto) automatically generates subnetworks in different regions; C(custom) uses networks to group subnets of user specified IP address ranges cloud.google.com/compute/docs/networking#network_types

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 53

attribute :mode

#name ⇒ String^?

Returns name of the network.

Returns:

• (String, nil) —

  name of the network

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 24

attribute :name

#pem_file ⇒ Object^?

Returns path to the pem file associated with the service account email This option is deprecated. Use C(credentials_file).

Returns:

• (Object, nil) —

  path to the pem file associated with the service account email This option is deprecated. Use C(credentials_file).

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 44

attribute :pem_file

#project_id ⇒ Object^?

Returns your GCE project ID.

Returns:

• (Object, nil) —

  your GCE project ID

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 50

attribute :project_id

#service_account_email ⇒ Object^?

Returns service account email.

Returns:

• (Object, nil) —

  service account email

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 41

attribute :service_account_email

#src_range ⇒ Object^?

Returns the source IPv4 address range in CIDR notation.

Returns:

• (Object, nil) —

  the source IPv4 address range in CIDR notation

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 28

attribute :src_range

#src_tags ⇒ Object^?

Returns the source instance tags for creating a firewall rule.

Returns:

• (Object, nil) —

  the source instance tags for creating a firewall rule

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 31

attribute :src_tags

#state ⇒ :active, ...

Returns desired state of the network or firewall.

Returns:

• (:active, :present, :absent, :deleted, nil) —

  desired state of the network or firewall

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 37

attribute :state

#subnet_desc ⇒ Object^?

Returns description of subnet to create.

Returns:

• (Object, nil) —

  description of subnet to create

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 65

attribute :subnet_desc

#subnet_name ⇒ String^?

Returns name of subnet to create.

Returns:

• (String, nil) —

  name of subnet to create

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 57

attribute :subnet_name

#subnet_region ⇒ String^?

Returns region of subnet to create.

Returns:

• (String, nil) —

  region of subnet to create

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 61

attribute :subnet_region

#target_tags ⇒ Object^?

Returns the target instance tags for creating a firewall rule.

Returns:

• (Object, nil) —

  the target instance tags for creating a firewall rule

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_net.rb', line 34

attribute :target_tags