Class: Ansible::Ruby::Modules::Gcp_compute_route

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

Overview

Represents a Route resource. A route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with virtual machines by tag, and the set of routes for a particular virtual machine is called its routing table. For each packet leaving a virtual machine, the system searches that virtual machine’s routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the next_hop field of the winning route – either to another virtual machine destination, a virtual machine gateway or a Compute Engine-operated gateway. Packets that do not match any route in the sending virtual machine’s routing table will be dropped. A Route resource must have exactly one specification of either nextHopGateway, nextHopInstance, nextHopIp, or nextHopVpnTunnel.

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

#description ⇒ Object?

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

  • (Object, nil) —

    An optional description of this resource. Provide this property when you create the resource.



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

attribute :description

#dest_range ⇒ String

Returns The destination range of outgoing packets that this route applies to.,Only IPv4 is supported.

Returns:

  • (String) —

    The destination range of outgoing packets that this route applies to.,Only IPv4 is supported.



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

attribute :dest_range

#name ⇒ String

Returns 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])?` 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.

Returns:

  • (String) —

    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])?` 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.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_route.rb', line 26

attribute :name

#network ⇒ String

Returns The network that this route applies to.

Returns:

  • (String) —

    The network that this route applies to.



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

attribute :network

#next_hop_gateway ⇒ String?

Returns URL to a gateway that should handle matching packets.,Currently, you can only specify the internet gateway, using a full or partial valid URL: * U(www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway) * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway .

Returns:



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

attribute :next_hop_gateway

#next_hop_instance ⇒ Object?

Returns URL to an instance that should handle matching packets.,You can specify this as a full or partial URL. For example: * U(www.googleapis.com/compute/v1/projects/project/zones/zone/) instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance .

Returns:

  • (Object, nil) —

    URL to an instance that should handle matching packets.,You can specify this as a full or partial URL. For example: * U(www.googleapis.com/compute/v1/projects/project/zones/zone/) instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance .



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_route.rb', line 45

attribute :next_hop_instance

#next_hop_ip ⇒ Object?

Returns Network IP address of an instance that should handle matching packets.

Returns:

  • (Object, nil) —

    Network IP address of an instance that should handle matching packets.



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_route.rb', line 48

attribute :next_hop_ip

#next_hop_vpn_tunnel ⇒ Object?

Returns URL to a VpnTunnel that should handle matching packets.

Returns:

  • (Object, nil) —

    URL to a VpnTunnel that should handle matching packets.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_route.rb', line 51

attribute :next_hop_vpn_tunnel

#priority ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



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

attribute :priority

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



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

attribute :state

#tags ⇒ Array<String>, ...

Returns A list of instance tags to which this route applies.

Returns:

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

    A list of instance tags to which this route applies.



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

attribute :tags