Class: Ansible::Ruby::Modules::Os_floating_ip

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/openstack/os_floating_ip.rb

Overview

Add or Remove a floating IP to an instance

Instance Method Summary

• #availability_zone ⇒ Object^?

  Ignored.

• #fixed_address ⇒ String^?

  To which fixed IP of server the floating IP address should be attached to.

• #floating_ip_address ⇒ String^?

  A floating IP address to attach or to detach.

• #nat_destination ⇒ String^?

  The name or id of a neutron private network that the fixed IP to attach floating IP is on.

• #network ⇒ String^?

  The name or ID of a neutron external network or a nova pool name.

• #purge ⇒ :yes, ...

  When I(state) is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server.

• #reuse ⇒ :yes, ...

  When I(state) is present, and I(floating_ip_address) is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project.

• #server ⇒ String

  The name or ID of the instance to which the IP address should be assigned.

• #state ⇒ :present, ...

  Should the resource be present or absent.

• #timeout ⇒ Integer^?

  Time to wait for an IP address to appear as attached.

• #wait ⇒ :yes, ...

  When attaching a floating IP address, specify whether we should wait for it to appear as attached.

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

#availability_zone ⇒ Object^?

Returns Ignored. Present for backwards compatibility.

Returns:

• (Object, nil) —

  Ignored. Present for backwards compatibility

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_floating_ip.rb', line 52

attribute :availability_zone

#fixed_address ⇒ String^?

Returns To which fixed IP of server the floating IP address should be attached to.

Returns:

• (String, nil) —

  To which fixed IP of server the floating IP address should be attached to.

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

attribute :fixed_address

#floating_ip_address ⇒ String^?

Returns A floating IP address to attach or to detach. Required only if I(state) is absent. When I(state) is present can be used to specify a IP address to attach.

Returns:

• (String, nil) —

  A floating IP address to attach or to detach. Required only if I(state) is absent. When I(state) is present can be used to specify a IP address to attach.

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

attribute :floating_ip_address

#nat_destination ⇒ String^?

Returns The name or id of a neutron private network that the fixed IP to attach floating IP is on.

Returns:

• (String, nil) —

  The name or id of a neutron private network that the fixed IP to attach floating IP is on

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

attribute :nat_destination

#network ⇒ String^?

Returns The name or ID of a neutron external network or a nova pool name.

Returns:

• (String, nil) —

  The name or ID of a neutron external network or a nova pool name.

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

attribute :network

#purge ⇒ :yes, ...

Returns When I(state) is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only.

Returns:

• (:yes, :no, nil) —

  When I(state) is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_floating_ip.rb', line 48

attribute :purge

#reuse ⇒ :yes, ...

Returns When I(state) is present, and I(floating_ip_address) is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project.

Returns:

• (:yes, :no, nil) —

  When I(state) is present, and I(floating_ip_address) is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project.

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

attribute :reuse

#server ⇒ String

Returns The name or ID of the instance to which the IP address should be assigned.

Returns:

• (String) —

  The name or ID of the instance to which the IP address should be assigned.

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

attribute :server

#state ⇒ :present, ...

Returns Should the resource be present or absent.

Returns:

• (:present, :absent, nil) —

  Should the resource be present or absent.

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

attribute :state

#timeout ⇒ Integer^?

Returns Time to wait for an IP address to appear as attached. See wait.

Returns:

• (Integer, nil) —

  Time to wait for an IP address to appear as attached. See wait.

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

attribute :timeout

#wait ⇒ :yes, ...

Returns When attaching a floating IP address, specify whether we should wait for it to appear as attached.

Returns:

• (:yes, :no, nil) —

  When attaching a floating IP address, specify whether we should wait for it to appear as attached.

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

attribute :wait