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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/google/gce_net.rb

Overview

This module can create and destroy Google Compute Engine networks and firewall rules U(developers.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 collapse

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 ⇒ Array<String>, ...

Returns the protocol:ports to allow (‘tcp:80’ or ‘tcp:80,443’ or ‘tcp:80-800;udp:1-25’).

Returns:

  • (Array<String>, String, nil) —

    the protocol:ports to allow (‘tcp:80’ or ‘tcp:80,443’ or ‘tcp:80-800;udp:1-25’)



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

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



47
 
# File 'lib/ansible/ruby/modules/generated/core/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



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

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



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

attribute :ipv4_range

#name ⇒ String?

Returns name of the network.

Returns:

  • (String, nil) —

    name of the network



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

attribute :name

#pem_file ⇒ Object?

Returns path to the pem file associated with the service account email This option is deprecated. Use ‘credentials_file’.

Returns:

  • (Object, nil) —

    path to the pem file associated with the service account email This option is deprecated. Use ‘credentials_file’.



44
 
# File 'lib/ansible/ruby/modules/generated/core/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



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

attribute :project_id

#service_account_email ⇒ Object?

Returns service account email.

Returns:

  • (Object, nil) —

    service account email



41
 
# File 'lib/ansible/ruby/modules/generated/core/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



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

attribute :src_range

#src_tags ⇒ Array<String>, ...

Returns the source instance tags for creating a firewall rule.

Returns:

  • (Array<String>, String, nil) —

    the source instance tags for creating a firewall rule



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

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



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

attribute :state

#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



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

attribute :target_tags