Class: Ansible::Ruby::Modules::Os_router

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

Overview

Create or Delete routers from OpenStack. Although Neutron allows routers to share the same name, this module enforces name uniqueness to be more user friendly.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#admin_state_up ⇒ :yes, ...

Returns Desired admin state of the created or existing router.

Returns:

  • (:yes, :no, nil) —

    Desired admin state of the created or existing router.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 20

attribute :admin_state_up

#availability_zone ⇒ Object?

Returns Ignored. Present for backwards compatibility.

Returns:

  • (Object, nil) —

    Ignored. Present for backwards compatibility



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 44

attribute :availability_zone

#enable_snat ⇒ Symbol?

Returns Enable Source NAT (SNAT) attribute.

Returns:

  • (Symbol, nil) —

    Enable Source NAT (SNAT) attribute.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 24

attribute :enable_snat

#external_fixed_ips ⇒ Array<Hash>, ...

Returns The IP address parameters for the external gateway network. Each is a dictionary with the subnet name or ID (subnet) and the IP address to assign on the subnet (ip). If no IP is specified, one is automatically assigned from that subnet.

Returns:

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

    The IP address parameters for the external gateway network. Each is a dictionary with the subnet name or ID (subnet) and the IP address to assign on the subnet (ip). If no IP is specified, one is automatically assigned from that subnet.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 36

attribute :external_fixed_ips

#interfaces ⇒ Array<String>, ...

Returns List of subnets to attach to the router internal interface. Default gateway associated with the subnet will be automatically attached with the router’s internal interface. In order to provide an ip address different from the default gateway,parameters are passed as dictionary with keys as network name or ID(net), subnet name or ID (subnet) and the IP of port (portip) from the network. User defined portip is often required when a multiple router need to be connected to a single subnet for which the default gateway has been already used.

Returns:

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

    List of subnets to attach to the router internal interface. Default gateway associated with the subnet will be automatically attached with the router’s internal interface. In order to provide an ip address different from the default gateway,parameters are passed as dictionary with keys as network name or ID(net), subnet name or ID (subnet) and the IP of port (portip) from the network. User defined portip is often required when a multiple router need to be connected to a single subnet for which the default gateway has been already used.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 40

attribute :interfaces

#name ⇒ String

Returns Name to be give to the router.

Returns:

  • (String) —

    Name to be give to the router



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 16

attribute :name

#network ⇒ String?

Returns Unique name or ID of the external gateway network.,required I(interfaces) or I(enable_snat) are provided.

Returns:

  • (String, nil) —

    Unique name or ID of the external gateway network.,required I(interfaces) or I(enable_snat) are provided.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 28

attribute :network

#project ⇒ String?

Returns Unique name or ID of the project.

Returns:

  • (String, nil) —

    Unique name or ID of the project.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 32

attribute :project

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Indicate desired state of the resource



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_router.rb', line 12

attribute :state