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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/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, #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 ⇒ Boolean?

Returns Desired admin state of the created or existing router.

Returns:

  • (Boolean, nil) —

    Desired admin state of the created or existing router.



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

attribute :admin_state_up

#enable_snat ⇒ Boolean?

Returns Enable Source NAT (SNAT) attribute.

Returns:

  • (Boolean, nil) —

    Enable Source NAT (SNAT) attribute.



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

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.



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

attribute :external_fixed_ips

#interfaces ⇒ Array<String>, ...

Returns List of subnets to attach to the router internal interface.

Returns:

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

    List of subnets to attach to the router internal interface.



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

attribute :interfaces

#name ⇒ String

Returns Name to be give to the router.

Returns:

  • (String) —

    Name to be give to the router



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

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.



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

attribute :network

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Indicate desired state of the resource



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

attribute :state